From 0ea0670dc21d210c77275b4660da98e69669d917 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 29 Sep 2026 05:09:15 +0000 Subject: [PATCH 1/6] Update Postman collections and regenerate CLI commands --- cmd/admin/archive_users.go | 31 + cmd/admin/calling_metrics.go | 78 + cmd/admin/data_sources.go | 18 +- cmd/admin/identity_org.go | 107 + cmd/admin/people.go | 2 +- cmd/admin/recordings.go | 137 +- cmd/admin/reports.go | 3 + cmd/admin/scim_2_users.go | 4 +- cmd/calling/call_controls.go | 172 + cmd/cc/activities.go | 250 + cmd/cc/agent_personal_greeting_files.go | 52 +- cmd/cc/agent_summaries.go | 3 - cmd/cc/asset.go | 329 + cmd/cc/business_hour.go | 20 +- cmd/cc/call_monitoring.go | 23 + cmd/cc/campaign_group.go | 65 + cmd/cc/campaign_manager.go | 74 +- cmd/cc/captures.go | 2 +- cmd/cc/channel.go | 319 + cmd/cc/contact_list_management.go | 57 +- cmd/cc/contact_service_queue.go | 98 +- cmd/cc/data_sources.go | 18 +- cmd/cc/desktop_layout.go | 2 +- cmd/cc/desktop_profile.go | 329 +- cmd/cc/dial_plan.go | 48 +- cmd/cc/events.go | 86 + cmd/cc/external_data_updates.go | 62 + cmd/cc/flows.go | 985 + cmd/cc/functions.go | 458 + cmd/cc/holiday_list.go | 14 +- cmd/cc/legacy_flows.go | 98 + cmd/cc/notification.go | 2 +- cmd/cc/outdial_ani.go | 36 +- cmd/cc/overrides.go | 2 +- cmd/cc/realtime.go | 2 +- cmd/cc/search_metadata.go | 58 + cmd/cc/skill.go | 89 +- cmd/cc/tasks.go | 87 +- cmd/cc/team.go | 22 +- cmd/cc/templates.go | 148 + cmd/cc/usage_reports.go | 200 + cmd/cc/user_profiles.go | 2 +- cmd/cc/users.go | 118 +- cmd/device/device_call.go | 4 +- cmd/meetings/meetings.go | 127 +- cmd/meetings/people.go | 2 +- cmd/meetings/recordings.go | 137 +- cmd/messaging/hds.go | 148 +- cmd/messaging/hybrid_data_security.go | 398 + cmd/messaging/people.go | 2 +- .../Webex Admin.postman_collection.json | 85893 ++++++++-------- ...ebex Cloud Calling.postman_collection.json | 3379 +- ...bex Contact Center.postman_collection.json | 54290 ++++++++-- .../Webex Device.postman_collection.json | 48 +- .../Webex Meetings.postman_collection.json | 25061 +++-- .../Webex Messaging.postman_collection.json | 9498 +- skill/admin/SKILL.md | 15 +- skill/calling/SKILL.md | 5 + skill/cc/SKILL.md | 212 +- skill/meetings/SKILL.md | 7 +- skill/messaging/SKILL.md | 20 + 61 files changed, 122982 insertions(+), 60974 deletions(-) create mode 100644 cmd/admin/calling_metrics.go create mode 100644 cmd/cc/activities.go create mode 100644 cmd/cc/asset.go create mode 100644 cmd/cc/campaign_group.go create mode 100644 cmd/cc/channel.go create mode 100644 cmd/cc/events.go create mode 100644 cmd/cc/external_data_updates.go create mode 100644 cmd/cc/flows.go create mode 100644 cmd/cc/functions.go create mode 100644 cmd/cc/legacy_flows.go create mode 100644 cmd/cc/search_metadata.go create mode 100644 cmd/cc/templates.go create mode 100644 cmd/cc/usage_reports.go create mode 100644 cmd/messaging/hybrid_data_security.go diff --git a/cmd/admin/archive_users.go b/cmd/admin/archive_users.go index 7213225..ab1ae94 100644 --- a/cmd/admin/archive_users.go +++ b/cmd/admin/archive_users.go @@ -57,4 +57,35 @@ func init() { archiveUsersCmd.AddCommand(cmd) } + { // query + var orgId string + var filter string + cmd := &cobra.Command{ + Use: "query", + Short: "Query Archive User", + Long: "Retrieves archived user information for the specified organization. Supported attributes are `id`, which is the unique identifier of a user in the system, and `username`. It is assigned when the user is created and can be retrieved through **GET Users** API.
\n\n**Authorization**\n\nOAuth token issued by the Identity Broker.\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`.\n- `identity:people_read`.\n\nThe following administrators can use this API:\n\n- `Account in the specified organization with one of the following roles: id_full_admin, id_user_admin, id_readonly_admin`.\n- `Proxy account managing the specified organization with one of the following roles: id_full_admin, id_user_admin, id_readonly_admin`.\n\n
", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/identity/organizations/{orgId}/v1/ArchivedUser") + req.PathParam("orgId", orgId) + req.QueryParam("filter", filter) + 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", "", "The unique identifier for the organization.") + cmd.MarkFlagRequired("org-id") + cmd.Flags().StringVar(&filter, "filter", "", "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported. Examples: - `username eq \"test_user_1@example.com\"` - `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`") + archiveUsersCmd.AddCommand(cmd) + } + } diff --git a/cmd/admin/calling_metrics.go b/cmd/admin/calling_metrics.go new file mode 100644 index 0000000..bf3adf9 --- /dev/null +++ b/cmd/admin/calling_metrics.go @@ -0,0 +1,78 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package admin + +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/Cloverhound/webex-cli/internal/timeutil" + "github.com/spf13/cobra" +) + +// Ensure imports are used. +var _ = fmt.Sprintf +var _ = config.Token +var _ = output.Print +var _ = timeutil.ParseLastISO + +var callingMetricsCmd = &cobra.Command{ + Use: "calling-metrics", + Short: "CallingMetrics commands", +} + +func init() { + cmd.AdminCmd.AddCommand(callingMetricsCmd) + + { // webex-call-quality-stats + var from string + var to string + var location string + var last string + cmd := &cobra.Command{ + Use: "webex-call-quality-stats", + Short: "Webex Calling Call Quality Stats", + Long: `Returns aggregated Webex Calling call and media-quality statistics for the authenticated organization. A call or media session is classified as good quality when all available audio and video quality measurements meet their defined thresholds. Missing individual quality measurements do not cause the call or session to be classified as poor quality. + +You can query data for a time range of up to seven days within the previous 3 weeks. For older historical data, use the Webex Calling Media Quality dashboard or reports. For more information on Media Quality KPI definitions, [click here](https://help.webex.com/en-us/article/n0rlwxe/Analytics-for-Your-Cloud-Collaboration-Portfolio#Cisco_Concept.dita_7609f9dc-3b80-4c0f-9456-5aaa385c4e27). + +This operation requires a Pro Pack for Control Hub license. The access token must include the analytics:read_all scope and represent either a full administrator or read-only administrator. The organization is derived from the access token. + +
The base URL for these APIs is **analytics.webexapis.com**, which does not work with the **Try It** feature.
`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.AnalyticsBaseURL, "GET", "/v1/analytics/callQualityStats") + if last != "" { + var err error + from, to, err = timeutil.ParseLastISO(last) + if err != nil { + return err + } + } + req.QueryParam("from", from) + req.QueryParam("to", to) + req.QueryParam("location", location) + 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(&from, "from", "", "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.") + cmd.Flags().StringVar(&to, "to", "", "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.") + cmd.Flags().StringVar(&location, "location", "", "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.") + cmd.Flags().StringVar(&last, "last", "", "Time range shorthand (e.g. 1h, 30m, 24h). Sets --from automatically.") + callingMetricsCmd.AddCommand(cmd) + } + +} diff --git a/cmd/admin/data_sources.go b/cmd/admin/data_sources.go index eb766e9..3e5a348 100644 --- a/cmd/admin/data_sources.go +++ b/cmd/admin/data_sources.go @@ -39,7 +39,7 @@ func init() { cmd := &cobra.Command{ Use: "register", Short: "Register a Data Source", - Long: "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.", + Long: "Register a data source with the Webex BYODS system. Authenticate using a Service App with the `spark-admin:datasource_write` scope.\nSchema IDs determine the types of data Webex sends to the DAP and the expected responses. Use the Data Source Schemas endpoints to inspect the available schemas.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "POST", "/dataSources") if bodyFile != "" { @@ -78,7 +78,7 @@ func init() { cmd := &cobra.Command{ Use: "get-all", Short: "Retrieve All Data Sources", - Long: "Show all data sources registered for this Service App with the scope `spark-admin:datasource_read`.", + Long: "Lists all data sources registered by the Service App. Requires the `spark-admin:datasource_read` scope.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/dataSources") if config.Paginate() { @@ -102,7 +102,7 @@ func init() { cmd := &cobra.Command{ Use: "get-schemas", Short: "Retrieve Data Source Schemas", - Long: `Show available schemas. No specific scope is needed to retrieve the dataSource schemas, but a valid API token should be presented.`, + Long: `Lists the available data source schemas. A valid API access token is required, but no specific scope is needed.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/dataSources/schemas") if config.Paginate() { @@ -127,7 +127,7 @@ func init() { cmd := &cobra.Command{ Use: "get-schema", Short: "Retrieve Details of a Specific Data Source Schema", - Long: `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.`, + Long: `Retrieves details for a specific data source schema by schema ID. A valid API access token is required, but no specific scope is needed.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/dataSources/schemas/{schemaId}") req.PathParam("schemaId", schemaId) @@ -155,7 +155,7 @@ func init() { cmd := &cobra.Command{ Use: "delete", Short: "Delete a Data Source", - Long: "Delete a Data Source, by Data Source ID.\n\nSpecify the Data Source ID in the `dataSourceId` parameter in the URI.", + Long: "Deletes a data source by ID.\n\nSpecify the data source ID in the `dataSourceId` URI parameter.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "DELETE", "/dataSources/{dataSourceId}") req.PathParam("dataSourceId", dataSourceId) @@ -166,7 +166,7 @@ func init() { return output.Print(resp, statusCode) }, } - cmd.Flags().StringVar(&dataSourceId, "data-source-id", "", "The unique identifier for the dataSource.") + cmd.Flags().StringVar(&dataSourceId, "data-source-id", "", "The unique identifier for the data source.") cmd.MarkFlagRequired("data-source-id") dataSourcesCmd.AddCommand(cmd) } @@ -176,7 +176,7 @@ func init() { cmd := &cobra.Command{ Use: "get", Short: "Retrieve Data Source Details", - Long: "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.", + Long: "Retrieves details for a data source by ID. Use a Service App token with the `spark-admin:datasource_read` scope.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/dataSources/{dataSourceId}") req.PathParam("dataSourceId", dataSourceId) @@ -194,7 +194,7 @@ func init() { return output.Print(resp, statusCode) }, } - cmd.Flags().StringVar(&dataSourceId, "data-source-id", "", "The unique identifier for the dataSource.") + cmd.Flags().StringVar(&dataSourceId, "data-source-id", "", "The unique identifier for the data source.") cmd.MarkFlagRequired("data-source-id") dataSourcesCmd.AddCommand(cmd) } @@ -214,7 +214,7 @@ func init() { cmd := &cobra.Command{ Use: "update", Short: "Update a Data Source", - Long: "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.", + Long: "Updates a data source. The fields you can update are `audience`, `subject`, `nonce`, `url`, and `tokenLifetimeMinutes`.\nYou can set `status` from `active` to `disabled` only if you provide an `errorMessage`, which may be shown to the customer administrator in Control Hub.\nUpdate tokens before they expire to prevent service interruption.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/dataSources/{dataSourceId}") req.PathParam("dataSourceId", dataSourceId) diff --git a/cmd/admin/identity_org.go b/cmd/admin/identity_org.go index cf5a15e..cdc3677 100644 --- a/cmd/admin/identity_org.go +++ b/cmd/admin/identity_org.go @@ -4,6 +4,7 @@ package admin 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 identityOrgCmd = &cobra.Command{ @@ -122,4 +124,109 @@ func init() { identityOrgCmd.AddCommand(cmd) } + { // update-authentication-configuration-settings + var orgId string + var schemas []string + var rememberMyLoginId bool + var rememberMyLoginIdDuration int64 + var mfaEnabled bool + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update-authentication-configuration-settings", + Short: "Update Organization Authentication Configuration Settings", + Long: "Update the authentication configuration details, by organizationID.\nSpecify the organization ID in the `orgId` parameter in the URI.\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:organizations_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n
\n\n**Usage**:\n\n1. Input JSON must contain schema: \"urn:cisco:codev:identity:idbroker:authnconfig:schemas:1.0\".", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "PATCH", "/identity/organizations/{orgId}/authenticationConfig") + req.PathParam("orgId", orgId) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyStringSlice("schemas", schemas) + req.BodyBool("RememberMyLoginId", rememberMyLoginId, cmd.Flags().Changed("remember-my-login-id")) + req.BodyInt("RememberMyLoginIdDuration", rememberMyLoginIdDuration, cmd.Flags().Changed("remember-my-login-id-duration")) + req.BodyBool("mfaEnabled", mfaEnabled, cmd.Flags().Changed("mfa-enabled")) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgId, "org-id", "", "A unique identifier for the org.") + cmd.MarkFlagRequired("org-id") + cmd.Flags().StringSliceVar(&schemas, "schemas", nil, "") + cmd.Flags().BoolVar(&rememberMyLoginId, "remember-my-login-id", false, "") + cmd.Flags().Int64Var(&rememberMyLoginIdDuration, "remember-my-login-id-duration", 0, "") + cmd.Flags().BoolVar(&mfaEnabled, "mfa-enabled", false, "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + identityOrgCmd.AddCommand(cmd) + } + + { // update-password-policy + var orgId string + var schemas []string + var minimumNumeric string + var minimumCapAlpha string + var minimumLowAlpha string + var minimumSpecial string + var minimumLength string + var historyCount string + var maxPasswordAge string + var notAcceptableStrings string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update-password-policy", + Short: "Update Organization Password Policy", + Long: "Update Organization Password Policy, by organizationID.\nSpecify the organization ID in the `orgId` parameter in the URI.\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:organizations_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n
\n\n**Usage**:\n\n1. Input JSON must contain schema: \"urn:cisco:codev:identity:idbroker:pwdpolicy:schemas:1.0\".", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "PATCH", "/identity/organizations/{orgId}/passwordPolicy") + req.PathParam("orgId", orgId) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyStringSlice("schemas", schemas) + req.BodyString("minimumNumeric", minimumNumeric) + req.BodyString("minimumCapAlpha", minimumCapAlpha) + req.BodyString("minimumLowAlpha", minimumLowAlpha) + req.BodyString("minimumSpecial", minimumSpecial) + req.BodyString("minimumLength", minimumLength) + req.BodyString("historyCount", historyCount) + req.BodyString("maxPasswordAge", maxPasswordAge) + req.BodyString("notAcceptableStrings", notAcceptableStrings) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgId, "org-id", "", "A unique identifier for the org.") + cmd.MarkFlagRequired("org-id") + cmd.Flags().StringSliceVar(&schemas, "schemas", nil, "") + cmd.Flags().StringVar(&minimumNumeric, "minimum-numeric", "", "") + cmd.Flags().StringVar(&minimumCapAlpha, "minimum-cap-alpha", "", "") + cmd.Flags().StringVar(&minimumLowAlpha, "minimum-low-alpha", "", "") + cmd.Flags().StringVar(&minimumSpecial, "minimum-special", "", "") + cmd.Flags().StringVar(&minimumLength, "minimum-length", "", "") + cmd.Flags().StringVar(&historyCount, "history-count", "", "") + cmd.Flags().StringVar(&maxPasswordAge, "max-password-age", "", "") + cmd.Flags().StringVar(¬AcceptableStrings, "not-acceptable-strings", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + identityOrgCmd.AddCommand(cmd) + } + } diff --git a/cmd/admin/people.go b/cmd/admin/people.go index aaeb56a..8d628b1 100644 --- a/cmd/admin/people.go +++ b/cmd/admin/people.go @@ -153,7 +153,7 @@ func init() { cmd := &cobra.Command{ Use: "update-person", Short: "Update a Person", - Long: "Update details for a person, by ID.\n\nSpecify the person ID in the `personId` parameter in the URI. Only an admin can update a person details.\n\nInclude all details for the person. This action expects all user details to be present in the request. A common approach is to first [GET the person's details](/docs/api/v1/people/get-person-details), make changes, then PUT both the changed and unchanged values.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.\n\nWhen doing attendee management, to update a user from host role to an attendee for a site append `#attendee` to the respective `siteUrl` and remove the meeting host license for this site from the license array.\nTo update a person from an attendee role to a host for a site, add the meeting license for this site in the meeting array, and remove that site from the `siteurl` parameter.\n\nTo remove the attendee privilege for a user on a meeting site, remove the `sitename#attendee` from the `siteUrl`s array. The `showAllTypes` parameter must be set to `true`.\n\n**NOTE**:\n\n* The `locationId` can only be set when assigning a calling license to a user. It cannot be changed if a user is already an existing calling user.\n\n* The `extension` field should be used to update the Webex Calling extension for a person. The extension value should not include the location routing prefix. The `work_extension` type in the `phoneNumbers` object as seen in the response payload of [List People](/docs/api/v1/people/list-people) or [Get Person Details](/docs/api/v1/people/get-person-details), cannot be used to set the Webex Calling extension for a person.\n\n* When updating a user with multiple email addresses using a PUT request, ensure that the primary email address is listed first in the array. Note that the order of email addresses returned by a GET request is not guaranteed..\n\n* The People API is a combination of several microservices, each responsible for specific attributes of a person. As a result, a PUT request that returns an error response code may still have altered some values of the person's data. Therefore, it is recommended to perform a GET request after encountering an error to verify the current state of the resource. \n\n* Some licenses are implicitly assigned by the system and cannot be admin controlled. They are necessary for the baseline function of the Webex system. If you get an error about implicitly assigned licensed that cannot be removed, please ensure you have the corresponding license in your PUT request.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.", + Long: "Update details for a person, by ID.\n\nSpecify the person ID in the `personId` parameter in the URI. Only an admin can update a person details.\n\nInclude all details for the person. This action expects all user details to be present in the request. A common approach is to first [GET the person's details](/docs/api/v1/people/get-person-details), make changes, then PUT both the changed and unchanged values.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.\n\nWhen doing attendee management, to update a user from host role to an attendee for a site append `#attendee` to the respective `siteUrl` and remove the meeting host license for this site from the license array.\nTo update a person from an attendee role to a host for a site, add the meeting license for this site in the meeting array, and remove that site from the `siteurl` parameter.\n\nTo remove the attendee privilege for a user on a meeting site, remove the `sitename#attendee` from the `siteUrl`s array. The `showAllTypes` parameter must be set to `true`.\n\n**NOTE**:\n\n* When assigning a Webex Calling license, either a telephone number or extension must already be assigned to the person or provided in the request payload.\n\n* When `callingData` is set to `true`, a Webex Calling license must be included in the `licenses` array.\n\n* The `locationId` can only be set when assigning a calling license to a user. It cannot be changed if a user is already an existing calling user.\n\n* The `extension` field should be used to update the Webex Calling extension for a person. The extension value should not include the location routing prefix. The `work_extension` type in the `phoneNumbers` object as seen in the response payload of [List People](/docs/api/v1/people/list-people) or [Get Person Details](/docs/api/v1/people/get-person-details), cannot be used to set the Webex Calling extension for a person.\n\n* When updating a user with multiple email addresses using a PUT request, ensure that the primary email address is listed first in the array. Note that the order of email addresses returned by a GET request is not guaranteed..\n\n* The People API is a combination of several microservices, each responsible for specific attributes of a person. As a result, a PUT request that returns an error response code may still have altered some values of the person's data. Therefore, it is recommended to perform a GET request after encountering an error to verify the current state of the resource. \n\n* Some licenses are implicitly assigned by the system and cannot be admin controlled. They are necessary for the baseline function of the Webex system. If you get an error about implicitly assigned licensed that cannot be removed, please ensure you have the corresponding license in your PUT request.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/people/{personId}") req.PathParam("personId", personId) diff --git a/cmd/admin/recordings.go b/cmd/admin/recordings.go index 8ae9ae3..6bb29c5 100644 --- a/cmd/admin/recordings.go +++ b/cmd/admin/recordings.go @@ -4,6 +4,7 @@ package admin import ( "fmt" + "strconv" "strings" cmd "github.com/Cloverhound/webex-cli/cmd" @@ -18,6 +19,7 @@ import ( var _ = fmt.Sprintf var _ = config.Token var _ = output.Print +var _ = strconv.Itoa var _ = strings.Join var _ = timeutil.ParseLastISO @@ -46,7 +48,7 @@ func init() { cmd := &cobra.Command{ Use: "list", Short: "List Recordings", - Long: "Lists recordings. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nOnly recordings of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. **NOTE**: when `meetingId` is specified, parameter of `siteUrl` will be ignored.\n\n* If `siteUrl` is specified, recordings of the specified site will be listed; otherwise, the API lists recordings of all the user's sites. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + Long: "
This API is still supported and behaves the same as before, but will be deprecated in the future. Due to limited support for special characters when filtering recordings by `topic`, it is recommended to use the new [Query Recordings](/docs/api/v1/recordings/query-recordings) API instead.
\n\nLists recordings. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nOnly recordings of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. **NOTE**: when `meetingId` is specified, parameter of `siteUrl` will be ignored.\n\n* If `siteUrl` is specified, recordings of the specified site will be listed; otherwise, the API lists recordings of all the user's sites. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/recordings") if last != "" { @@ -114,7 +116,7 @@ func init() { cmd := &cobra.Command{ Use: "list-admin-compliance-officer", Short: "List Recordings For an Admin or Compliance Officer", - Long: "List recordings for an admin or compliance officer. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. Please note that when `meetingId` is specified, parameters of `siteUrl`, `from`, and `to` will be ignored.\n\n* If `siteUrl` is specified, all the recordings on the specified site are listed; otherwise, all the recordings on the admin user's or compliance officer's preferred site are listed. All the available Webex sites and the admin user's or compliance officer's preferred site can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + Long: "
This API is still supported and behaves the same as before, but will be deprecated in the future. Due to limited support for special characters when filtering recordings by `topic`, it is recommended to use the new [Query Recordings For an Admin or Compliance Officer](/docs/api/v1/recordings/query-recordings-for-an-admin-or-compliance-officer) API instead.
\n\nList recordings for an admin or compliance officer. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. Please note that when `meetingId` is specified, parameters of `siteUrl`, `from`, and `to` will be ignored.\n\n* If `siteUrl` is specified, all the recordings on the specified site are listed; otherwise, all the recordings on the admin user's or compliance officer's preferred site are listed. All the available Webex sites and the admin user's or compliance officer's preferred site can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/admin/recordings") if last != "" { @@ -436,7 +438,6 @@ func init() { var to string var siteUrl string var integrationTag string - var topic string var format string var serviceType string var timezone string @@ -461,7 +462,6 @@ func init() { req.QueryParam("to", to) req.QueryParam("siteUrl", siteUrl) req.QueryParam("integrationTag", integrationTag) - req.QueryParam("topic", topic) req.QueryParam("format", format) req.QueryParam("serviceType", serviceType) req.Header("timezone", timezone) @@ -486,7 +486,6 @@ func init() { cmd.Flags().StringVar(&to, "to", "", "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.") cmd.Flags().StringVar(&siteUrl, "site-url", "", "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.") cmd.Flags().StringVar(&integrationTag, "integration-tag", "", "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".") - cmd.Flags().StringVar(&topic, "topic", "", "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.") cmd.Flags().StringVar(&format, "format", "", "Recording's file format. If specified, the API filters recordings by format.") cmd.Flags().StringVar(&serviceType, "service-type", "", "The service type for recordings. If specified, the API filters recordings by service type.") cmd.Flags().StringVar(&timezone, "timezone", "", "e.g. UTC") @@ -576,4 +575,132 @@ func init() { recordingsCmd.AddCommand(cmd) } + { // query + var timezone string + var max int64 + var from string + var to string + var meetingId string + var siteUrl string + var integrationTag string + var hostEmail string + var topic string + var format string + var serviceType string + var status string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "query", + Short: "Query Recordings", + Long: "Queries recordings with filters in the request body. You can specify a date range, a parent meeting ID, the maximum number of recordings to return, and additional filters such as siteUrl, integrationTag, hostEmail, topic, format, serviceType, and status.\n\nOnly recordings of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. **NOTE**: when `meetingId` is specified, parameter of `siteUrl` will be ignored.\n\n* If `siteUrl` is specified, recordings of the specified site will be listed; otherwise, the API lists recordings of all the user's sites. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "POST", "/recordings/query") + req.Header("timezone", timezone) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyInt("max", max, cmd.Flags().Changed("max")) + req.BodyString("from", from) + req.BodyString("to", to) + req.BodyString("meetingId", meetingId) + req.BodyString("siteUrl", siteUrl) + req.BodyString("integrationTag", integrationTag) + req.BodyString("hostEmail", hostEmail) + req.BodyString("topic", topic) + req.BodyString("format", format) + req.BodyString("serviceType", serviceType) + req.BodyString("status", status) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&timezone, "timezone", "", "e.g. UTC") + cmd.Flags().Int64Var(&max, "max", 0, "") + cmd.Flags().StringVar(&from, "from", "", "") + cmd.Flags().StringVar(&to, "to", "", "") + cmd.Flags().StringVar(&meetingId, "meeting-id", "", "") + cmd.Flags().StringVar(&siteUrl, "site-url", "", "") + cmd.Flags().StringVar(&integrationTag, "integration-tag", "", "") + cmd.Flags().StringVar(&hostEmail, "host-email", "", "") + cmd.Flags().StringVar(&topic, "topic", "", "") + cmd.Flags().StringVar(&format, "format", "", "") + cmd.Flags().StringVar(&serviceType, "service-type", "", "") + cmd.Flags().StringVar(&status, "status", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + recordingsCmd.AddCommand(cmd) + } + + { // query-admin-compliance-officer + var timezone string + var max int64 + var from string + var to string + var meetingId string + var siteUrl string + var integrationTag string + var topic string + var format string + var serviceType string + var status string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "query-admin-compliance-officer", + Short: "Query Recordings For an Admin or Compliance Officer", + Long: "Queries recordings for an admin or compliance officer with filters in the request body. You can specify a date range, a parent meeting ID, the maximum number of recordings to return, and additional filters such as siteUrl, integrationTag, topic, format, serviceType, and status.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. Please note that when `meetingId` is specified, parameters of `siteUrl`, `from`, and `to` will be ignored.\n\n* If `siteUrl` is specified, all the recordings on the specified site are listed; otherwise, all the recordings on the admin user's or compliance officer's preferred site are listed. All the available Webex sites and the admin user's or compliance officer's preferred site can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "POST", "/admin/recordings/query") + req.Header("timezone", timezone) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyInt("max", max, cmd.Flags().Changed("max")) + req.BodyString("from", from) + req.BodyString("to", to) + req.BodyString("meetingId", meetingId) + req.BodyString("siteUrl", siteUrl) + req.BodyString("integrationTag", integrationTag) + req.BodyString("topic", topic) + req.BodyString("format", format) + req.BodyString("serviceType", serviceType) + req.BodyString("status", status) + req.BodyString("timezone", timezone) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&timezone, "timezone", "", "e.g. UTC") + cmd.Flags().Int64Var(&max, "max", 0, "") + cmd.Flags().StringVar(&from, "from", "", "") + cmd.Flags().StringVar(&to, "to", "", "") + cmd.Flags().StringVar(&meetingId, "meeting-id", "", "") + cmd.Flags().StringVar(&siteUrl, "site-url", "", "") + cmd.Flags().StringVar(&integrationTag, "integration-tag", "", "") + cmd.Flags().StringVar(&topic, "topic", "", "") + cmd.Flags().StringVar(&format, "format", "", "") + cmd.Flags().StringVar(&serviceType, "service-type", "", "") + cmd.Flags().StringVar(&status, "status", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + recordingsCmd.AddCommand(cmd) + } + } diff --git a/cmd/admin/reports.go b/cmd/admin/reports.go index 60d619c..32ab846 100644 --- a/cmd/admin/reports.go +++ b/cmd/admin/reports.go @@ -82,6 +82,7 @@ func init() { var startDate string var endDate string var siteList string + var timeZone string var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -101,6 +102,7 @@ func init() { req.BodyString("startDate", startDate) req.BodyString("endDate", endDate) req.BodyString("siteList", siteList) + req.BodyString("timeZone", timeZone) } resp, statusCode, err := req.Do() if err != nil { @@ -113,6 +115,7 @@ func init() { cmd.Flags().StringVar(&startDate, "start-date", "", "") cmd.Flags().StringVar(&endDate, "end-date", "", "") cmd.Flags().StringVar(&siteList, "site-list", "", "") + 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") reportsCmd.AddCommand(cmd) diff --git a/cmd/admin/scim_2_users.go b/cmd/admin/scim_2_users.go index c1a9ed8..2f6912d 100644 --- a/cmd/admin/scim_2_users.go +++ b/cmd/admin/scim_2_users.go @@ -157,7 +157,7 @@ func init() { cmd := &cobra.Command{ Use: "update-put", Short: "Update a user with PUT", - 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. 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\n5. User `id` will not be changed.\n\n6. `meta`.`created` will not be changed.\n\n7. The PUT API replaces the contents of the user's data with the data in the request body. All attributes specified in the request body will replace all existing attributes for the `userId` specified in the URL. Should you wish to replace or change some attributes as opposed to all attributes please refer to the SCIM PATCH operation https://developer.webex.com/docs/api/v1/scim2-user/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. 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\n5. User `id` will not be changed.\n\n6. `meta`.`created` will not be changed.\n\n7. The PUT API replaces the contents of the user's data with the data in the request body. All attributes specified in the request body will replace all existing attributes for the `userId` specified in the URL. Should you wish to replace or change some attributes as opposed to all attributes please refer to the SCIM PATCH operation https://developer.webex.com/docs/api/v1/scim2-user/update-a-user-with-patch.\n\n
\n\n**NOTE**:\n\nOnce a user's role or managed roles are changed, all tokens associated with that user will be invalidated.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/identity/scim/{orgId}/v2/Users/{userId}") 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.\n\n The following roles cannot be assigned to a user:\n\n1. Location Admin\n\n2. Webex Site Admin", + 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 \n\n
\n\n**NOTE**:\n\nOnce a user's role or managed roles are changed, all tokens associated with that user will be invalidated.", 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/call_controls.go b/cmd/calling/call_controls.go index 6172368..5e215a1 100644 --- a/cmd/calling/call_controls.go +++ b/cmd/calling/call_controls.go @@ -1088,4 +1088,176 @@ func init() { callControlsCmd.AddCommand(cmd) } + { // dial-2 + var destination string + var endpointId string + var singleNumberReachPhoneNumber string + var lineOwnerId string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "dial-2", + Short: "Dial", + Long: `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.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/calls/members/me/dial") + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("destination", destination) + req.BodyString("endpointId", endpointId) + req.BodyString("singleNumberReachPhoneNumber", singleNumberReachPhoneNumber) + req.BodyString("lineOwnerId", lineOwnerId) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + 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") + callControlsCmd.AddCommand(cmd) + } + + { // answer-2 + var callId string + var endpointId string + var lineOwnerId string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "answer-2", + Short: "Answer", + Long: `Answer an incoming call. When no endpointId is specified, the call is answered on the user's primary device. When an endpointId is specified, the call is answered on the device or application identified by the endpointId. The answer API is rejected if the device is not alerting for the call or the device does not support answer via API.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/calls/members/me/answer") + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("callId", callId) + req.BodyString("endpointId", endpointId) + req.BodyString("lineOwnerId", lineOwnerId) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&callId, "call-id", "", "") + cmd.Flags().StringVar(&endpointId, "endpoint-id", "", "") + 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") + callControlsCmd.AddCommand(cmd) + } + + { // hangup-2 + var callId string + var lineOwnerId string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "hangup-2", + Short: "Hangup", + Long: `Hangup a call. If used on an unanswered incoming call, the call is rejected and sent to busy.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/calls/members/me/hangup") + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("callId", callId) + req.BodyString("lineOwnerId", lineOwnerId) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&callId, "call-id", "", "") + 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") + callControlsCmd.AddCommand(cmd) + } + + { // list-2 + var lineOwnerId string + cmd := &cobra.Command{ + Use: "list-2", + Short: "List Calls", + Long: `Get the list of details for all active calls associated with the user.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/calls/members/me/calls") + req.QueryParam("lineOwnerId", lineOwnerId) + 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(&lineOwnerId, "line-owner-id", "", "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.") + callControlsCmd.AddCommand(cmd) + } + + { // get-3 + var callId string + var lineOwnerId string + cmd := &cobra.Command{ + Use: "get-3", + Short: "Get Call Details", + Long: `Get the details of the specified active call for the user.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/calls/members/me/calls/{callId}") + req.PathParam("callId", callId) + req.QueryParam("lineOwnerId", lineOwnerId) + 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(&callId, "call-id", "", "The call identifier of the call.") + cmd.MarkFlagRequired("call-id") + cmd.Flags().StringVar(&lineOwnerId, "line-owner-id", "", "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.") + callControlsCmd.AddCommand(cmd) + } + } diff --git a/cmd/cc/activities.go b/cmd/cc/activities.go new file mode 100644 index 0000000..7bea220 --- /dev/null +++ b/cmd/cc/activities.go @@ -0,0 +1,250 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package cc + +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 activitiesCmd = &cobra.Command{ + Use: "activities", + Short: "Activities commands", +} + +func init() { + cmd.CcCmd.AddCommand(activitiesCmd) + + { // list-definitions + var orgid string + cmd := &cobra.Command{ + Use: "list-definitions", + Short: "List Activity Definitions", + Long: "List all available activity types with their full schemas, including inputs, outputs, ports, and descriptions. The response is sufficient on its own to construct nodes \u2014 there is no separate schema endpoint.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/activities") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + 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.") + cmd.MarkFlagRequired("orgid") + activitiesCmd.AddCommand(cmd) + } + + { // describe + var orgid string + var activityName string + cmd := &cobra.Command{ + Use: "describe", + Short: "Describe an Activity", + Long: "Retrieve a single activity's full definition, including inputs, outputs, named ports, and the JSON Schema for its inputs \u2014 all returned inline.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/activities/{activityName}") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("activityName", activityName) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&activityName, "activity-name", "", "Activity type name (e.g., `play-message`, `queue-contact`).") + cmd.MarkFlagRequired("activity-name") + activitiesCmd.AddCommand(cmd) + } + + { // get-input-choices + var orgid string + var activityName string + var inputName string + var mode string + var query string + var value string + var parent_inputs string + cmd := &cobra.Command{ + Use: "get-input-choices", + Short: "Get Activity Input Choices", + Long: "Resolve choices for an activity input. Use this when an activity input requires a value from a predefined or dynamically resolved set (e.g., available queues, audio files, agents).\n\nThis endpoint is only valid for inputs that expose choices (an input whose definition includes `allowedValues` or a `choicesEndpoint`, as returned by `describeActivity`). Calling it for an input that does not support choices returns 400.\n\n**Modes:**\n- `list` \u2014 Returns the full set of allowed values for a static-choice input.\n- `search` \u2014 Returns matches for the supplied `query` string. Use for type-ahead UIs over large choice sets.\n- `validate` \u2014 Checks whether a single `value` is allowed and returns its label/metadata if so.\n- `dynamic` \u2014 Resolves cascading choices whose allowed values depend on one or more sibling inputs. Pass the relevant sibling values via `parent_inputs` (e.g., a queue list scoped to a previously selected team).\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/activities/{activityName}/inputs/{inputName}/choices") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("activityName", activityName) + req.PathParam("inputName", inputName) + req.QueryParam("mode", mode) + req.QueryParam("query", query) + req.QueryParam("value", value) + req.QueryParam("parent_inputs", parent_inputs) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&activityName, "activity-name", "", "Activity type name.") + cmd.MarkFlagRequired("activity-name") + cmd.Flags().StringVar(&inputName, "input-name", "", "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).") + cmd.MarkFlagRequired("input-name") + cmd.Flags().StringVar(&mode, "mode", "", "Resolution mode. Defaults to `list`.") + cmd.Flags().StringVar(&query, "query", "", "Search term. Required when `mode=search`.") + cmd.Flags().StringVar(&value, "value", "", "Candidate value to validate. Required when `mode=validate`.") + cmd.Flags().StringVar(&parent_inputs, "parent_inputs", "", "JSON object of parent input values used for cascading resolution. Required when `mode=dynamic`.") + activitiesCmd.AddCommand(cmd) + } + + { // list-definitions-2 + var orgid string + cmd := &cobra.Command{ + Use: "list-definitions-2", + Short: "List Activity Definitions", + Long: "List all available activity types with their full schemas, including inputs, outputs, ports, and descriptions. The response is sufficient on its own to construct nodes \u2014 there is no separate schema endpoint.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/activities") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + 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.") + cmd.MarkFlagRequired("orgid") + activitiesCmd.AddCommand(cmd) + } + + { // describe-2 + var orgid string + var activityName string + cmd := &cobra.Command{ + Use: "describe-2", + Short: "Describe an Activity", + Long: "Retrieve a single activity's full definition, including inputs, outputs, named ports, and the JSON Schema for its inputs \u2014 all returned inline.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/activities/{activityName}") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("activityName", activityName) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&activityName, "activity-name", "", "Activity type name (e.g., `play-message`, `queue-contact`).") + cmd.MarkFlagRequired("activity-name") + activitiesCmd.AddCommand(cmd) + } + + { // get-input-choices-2 + var orgid string + var activityName string + var inputName string + var search string + var validate string + var parentValue string + var parentInputName string + cmd := &cobra.Command{ + Use: "get-input-choices-2", + Short: "Get Activity Input Choices", + Long: "Resolve choices for an activity input. Use this when an activity input requires a value from a predefined or dynamically resolved set (e.g., available queues, audio files, agents).\n\nThis endpoint is only valid for inputs that expose choices (an input whose definition includes `allowedValues` or a `choicesEndpoint`, as returned by `describeActivity`). Calling it for an input that does not support choices returns 400.\n\nPass `search` to filter the choices (type-ahead). Add `validate=true` together with `search` to do a point-lookup of a single value instead of filtering \u2014 the match is against the choice's `value` (its ID), not its display `name`. For a cascading input whose allowed values depend on a sibling input, supply the parent with `parentInputName` and `parentValue`; otherwise a cascading input returns 400.\n\nFiltering and validation apply only to dynamic (`choicesEndpoint`-backed) inputs. A static input always returns its full enumerated list regardless of `search`/`validate`.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/activities/{activityName}/inputs/{inputName}/choices") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("activityName", activityName) + req.PathParam("inputName", inputName) + req.QueryParam("search", search) + req.QueryParam("validate", validate) + req.QueryParam("parentValue", parentValue) + req.QueryParam("parentInputName", parentInputName) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&activityName, "activity-name", "", "Activity type name.") + cmd.MarkFlagRequired("activity-name") + cmd.Flags().StringVar(&inputName, "input-name", "", "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).") + cmd.MarkFlagRequired("input-name") + cmd.Flags().StringVar(&search, "search", "", "Search text used to filter the returned choices (type-ahead). When `validate=true`, this is instead the single value to look up.") + cmd.Flags().StringVar(&validate, "validate", "", "When `true` and `search` is supplied, performs a point-lookup of the single value in `search` (matched against the choice's `value`/ID) instead of filtering.") + cmd.Flags().StringVar(&parentValue, "parent-value", "", "Parent input value for a cascading/dynamic input (for example, the selected `channelType`).") + cmd.Flags().StringVar(&parentInputName, "parent-input-name", "", "Parent input name for a cascading/dynamic input. Required when `parentValue` is provided.") + activitiesCmd.AddCommand(cmd) + } + +} diff --git a/cmd/cc/agent_personal_greeting_files.go b/cmd/cc/agent_personal_greeting_files.go index 24bd426..259fbad 100644 --- a/cmd/cc/agent_personal_greeting_files.go +++ b/cmd/cc/agent_personal_greeting_files.go @@ -25,13 +25,14 @@ var agentPersonalGreetingFilesCmd = &cobra.Command{ func init() { cmd.CcCmd.AddCommand(agentPersonalGreetingFilesCmd) - { // create-v2-api + { // create var orgid string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "create-v2-api", - Short: "Create a new Greeting File using v2 API", + Use: "create", + Short: "Create a new Greeting File", + Long: `Create a new Greeting File in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/v2/agent-personal-greeting") req.PathParam("orgid", orgid) @@ -56,13 +57,14 @@ func init() { agentPersonalGreetingFilesCmd.AddCommand(cmd) } - { // delete-references-1 + { // delete-references var orgid string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "delete-references-1", - Short: "delete References 1", + Use: "delete-references", + Short: "Delete references of an agent from greeting files", + Long: `Removes all references of the specified agent (ciUserId) from greeting files in the given organization. Typically invoked when an agent is deleted or unassigned. in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/agent-personal-greeting/delete-reference") req.PathParam("orgid", orgid) @@ -87,13 +89,13 @@ func init() { agentPersonalGreetingFilesCmd.AddCommand(cmd) } - { // get-id-v2-api + { // get-id var orgid string var id string var includeUrl string cmd := &cobra.Command{ - Use: "get-id-v2-api", - Short: "Get specific Greeting File by ID using v2 API", + Use: "get-id", + Short: "Get specific Greeting File by ID", Long: `Retrieve an existing Greeting File by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/agent-personal-greeting/{id}") @@ -118,19 +120,19 @@ func init() { cmd.MarkFlagRequired("orgid") cmd.Flags().StringVar(&id, "id", "", "Resource ID of the Greeting File.") cmd.MarkFlagRequired("id") - cmd.Flags().StringVar(&includeUrl, "include-url", "", "Indicates if the URL for downloading Greeting Fileshould be included in the response.") + cmd.Flags().StringVar(&includeUrl, "include-url", "", "Indicates whether the URL for downloading the greeting file should be included in the response.") agentPersonalGreetingFilesCmd.AddCommand(cmd) } - { // update-id-v2-api + { // update-id var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id-v2-api", - Short: "Update specific Greeting File by ID using v2 API", - Long: `Update specific Greeting File by ID in a given organization.`, + Use: "update-id", + Short: "Update specific Greeting File by ID", + Long: `Update an existing Greeting File by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/v2/agent-personal-greeting/{id}") req.PathParam("orgid", orgid) @@ -158,13 +160,13 @@ func init() { agentPersonalGreetingFilesCmd.AddCommand(cmd) } - { // delete-id-v2-api + { // delete-id var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id-v2-api", - Short: "Delete specific Greeting File by ID using v2 API", - Long: `Delete an existing Greeting File by ID for a given organization.`, + Use: "delete-id", + Short: "Delete specific Greeting File by ID", + Long: `Delete an existing Greeting File by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/v2/agent-personal-greeting/{id}") req.PathParam("orgid", orgid) @@ -183,7 +185,7 @@ func init() { agentPersonalGreetingFilesCmd.AddCommand(cmd) } - { // patch-id-v2-api + { // patch-id var orgid string var id string var attributeTag string @@ -191,8 +193,8 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "patch-id-v2-api", - Short: "Partially update Greeting File by ID using v2 API", + Use: "patch-id", + Short: "Partially update Greeting File by ID", Long: `Partially update Greeting File by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PATCH", "/organization/{orgid}/v2/agent-personal-greeting/{id}") @@ -236,8 +238,8 @@ func init() { var includeAgentDetails string cmd := &cobra.Command{ Use: "list", - Short: "List Greeting File(s)", - Long: `Retrieve a list of Greeting File(s) in a given organization.`, + Short: "List Greeting Files", + Long: `Retrieve a list of Greeting Files in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v3/agent-personal-greeting") req.PathParam("orgid", orgid) @@ -263,12 +265,12 @@ 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 fields are : firstname, lastname, email, ciUserId and attribute tag 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(&filter, "filter", "", "Specify a filter based on which the results will be fetched. Supported fields are: firstName, lastName, email, ciUserId, and attributeTag. 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(&search, "search", "", "Filter data based on the search keyword.Supported search columns(firstName, lastName, email, attributeTag) The examples below show some search queries - \"Cisco\" - field==\"firstName\";value==\"Cisco\" - fields=in=(\"firstName\",\"email\");value==\"Cisco\" ") 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.") - cmd.Flags().StringVar(&includeAgentDetails, "include-agent-details", "", "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled.") + cmd.Flags().StringVar(&includeAgentDetails, "include-agent-details", "", "If includeAgentDetails is set to true, projection, filtering, searching, and sorting on the agent's firstName, lastName, and email will be enabled.") agentPersonalGreetingFilesCmd.AddCommand(cmd) } diff --git a/cmd/cc/agent_summaries.go b/cmd/cc/agent_summaries.go index 3b2f15f..3fb49d8 100644 --- a/cmd/cc/agent_summaries.go +++ b/cmd/cc/agent_summaries.go @@ -65,7 +65,6 @@ func init() { { // list-2 var orgId string - var agentCiUserId string var searchType string var bodyRaw string var bodyFile string @@ -83,7 +82,6 @@ func init() { req.SetBodyRaw(bodyRaw) } else { req.BodyString("orgId", orgId) - req.BodyString("agentCiUserId", agentCiUserId) req.BodyString("searchType", searchType) } resp, statusCode, err := req.Do() @@ -94,7 +92,6 @@ func init() { }, } cmd.Flags().StringVar(&orgId, "org-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/asset.go b/cmd/cc/asset.go new file mode 100644 index 0000000..08d5fc8 --- /dev/null +++ b/cmd/cc/asset.go @@ -0,0 +1,329 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package cc + +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 assetCmd = &cobra.Command{ + Use: "asset", + Short: "Asset commands", +} + +func init() { + cmd.CcCmd.AddCommand(assetCmd) + + { // create + var orgid string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "create", + Short: "Create a new Asset", + Long: `Create a new Asset in a given organization. Supports work item assets with the specified channel and data schema.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/asset") + 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") + assetCmd.AddCommand(cmd) + } + + { // bulk-save + var orgid string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "bulk-save", + Short: "Bulk save Assets", + Long: `Create, Update or delete Assets in bulk in a given organization. Supports CREATE, UPDATE, and DELETE actions in a single request.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/asset/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") + assetCmd.AddCommand(cmd) + } + + { // get-id + var orgid string + var id string + var includeChannelName string + cmd := &cobra.Command{ + Use: "get-id", + Short: "Get specific Asset by ID", + Long: `Retrieve an existing Asset by ID in a given organization. Set includeChannelName to true to include the channel name in the response.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/asset/{id}") + req.PathParam("orgid", orgid) + req.PathParam("id", id) + req.QueryParam("includeChannelName", includeChannelName) + 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 Asset") + cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&includeChannelName, "include-channel-name", "", "Include channel name in the response.") + assetCmd.AddCommand(cmd) + } + + { // update-id + var orgid string + var id string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update-id", + Short: "Update specific Asset by ID", + Long: `Update an existing Asset by ID in a given organization. Supported for WORK_ITEM assets. For CUSTOM_MESSAGING assets, use PATCH instead.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/asset/{id}") + 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 Asset") + cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + assetCmd.AddCommand(cmd) + } + + { // delete-id + var orgid string + var id string + cmd := &cobra.Command{ + Use: "delete-id", + Short: "Delete specific Asset by ID", + Long: `Delete an existing Asset by ID in a given organization. Validates whether the asset is associated with any flow before deletion.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/asset/{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 Asset") + cmd.MarkFlagRequired("id") + assetCmd.AddCommand(cmd) + } + + { // patch-id + var orgid string + var id string + var valueType string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "patch-id", + Short: "Partially update Asset by ID", + Long: `Partially update Asset by ID in a given organization. Supported only for CUSTOM_MESSAGING assets. Send only the fields to change; absent fields retain their current values. webhookConfig is optional; omit it to keep the existing credentials. For WORK_ITEM assets, use PUT instead.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "PATCH", "/organization/{orgid}/asset/{id}") + 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) + } else { + req.BodyString("valueType", valueType) + } + 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 Asset") + cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&valueType, "value-type", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + assetCmd.AddCommand(cmd) + } + + { // list-references + 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 Asset", + Long: `Retrieve a list of all entities that have reference to an existing Asset by ID in a given organization. For example, Entry Points.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/asset/{id}/incoming-references") + req.PathParam("orgid", orgid) + req.PathParam("id", id) + req.QueryParam("type", typeVal) + 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(&id, "id", "", "ID of this contact center resource.") + cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&typeVal, "type", "", "Entity type of the other entity that has a reference to this specific entity.") + 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.") + assetCmd.AddCommand(cmd) + } + + { // list + var orgid string + var filter string + var attributes string + var search string + var page string + var pageSize string + var sort string + var includeCount string + var singleObjectResponse string + var includeChannelName string + var excludeEpassociated string + cmd := &cobra.Command{ + Use: "list", + Short: "List Assets", + Long: `Retrieve a list of Assets in a given organization. Supports pagination metadata. Set includeChannelName to true to include the channel name in the response. Set excludeEPAssociated to true to return only assets that are not associated with any Entry Point.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/asset") + req.PathParam("orgid", orgid) + req.QueryParam("filter", filter) + req.QueryParam("attributes", attributes) + req.QueryParam("search", search) + req.QueryParam("page", page) + req.QueryParam("pageSize", pageSize) + req.QueryParam("sort", sort) + req.QueryParam("includeCount", includeCount) + req.QueryParam("singleObjectResponse", singleObjectResponse) + req.QueryParam("includeChannelName", includeChannelName) + req.QueryParam("excludeEPAssociated", excludeEpassociated) + 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", "", "Filter expression") + cmd.Flags().StringVar(&attributes, "attributes", "", "Supported attributes") + 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(&sort, "sort", "", "Sortable properties") + cmd.Flags().StringVar(&includeCount, "include-count", "", "Include count") + cmd.Flags().StringVar(&singleObjectResponse, "single-object-response", "", "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.") + cmd.Flags().StringVar(&includeChannelName, "include-channel-name", "", "Include channel name in the response.") + cmd.Flags().StringVar(&excludeEpassociated, "exclude-epassociated", "", "When true, return only assets that are not associated with any Entry Point.") + assetCmd.AddCommand(cmd) + } + +} diff --git a/cmd/cc/business_hour.go b/cmd/cc/business_hour.go index 2678080..cd53404 100644 --- a/cmd/cc/business_hour.go +++ b/cmd/cc/business_hour.go @@ -39,9 +39,9 @@ func init() { var singleObjectResponse string cmd := &cobra.Command{ Use: "list", - Short: "List Business Hours resource(s)", - Long: `Retrieve a list of Business Hours resource(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.`, + Short: "List Business Hours resources", + Long: `Retrieve a list of Business Hours resources in a given organization. + 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/business-hours") req.PathParam("orgid", orgid) @@ -75,8 +75,8 @@ func init() { 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(&sort, "sort", "", "Sorting criteria in the format: property(, asc | desc). Default sort order is ascending. Supported sortable fields (name, timezone, createdTime, lastUpdatedTime). The examples below show some sort queries - name,asc - timezone,desc ") - cmd.Flags().StringVar(&includeCount, "include-count", "", "Enable the flag to get the count of workingHours") - 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(&includeCount, "include-count", "", "Enable this flag to get the count of working hours.") + cmd.Flags().StringVar(&singleObjectResponse, "single-object-response", "", "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.") businessHourCmd.AddCommand(cmd) } @@ -118,8 +118,8 @@ func init() { var bodyFile string cmd := &cobra.Command{ Use: "bulk-save", - Short: "Bulk save Business Hours resource(s)", - Long: `Create, Update or delete Business Hours resource(s) in bulk in a given organization.`, + Short: "Bulk save Business Hours resources", + Long: `Create, Update or delete Business Hours resources in bulk in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/business-hours/bulk") req.PathParam("orgid", orgid) @@ -205,7 +205,7 @@ 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(&id, "id", "", "Resource ID of the Business Hours resource.") + cmd.Flags().StringVar(&id, "id", "", "Resource ID of the Business Hour.") cmd.MarkFlagRequired("id") businessHourCmd.AddCommand(cmd) } @@ -239,7 +239,7 @@ 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(&id, "id", "", "Resource ID of the Business Hours resource.") + cmd.Flags().StringVar(&id, "id", "", "Resource ID of the Business Hour.") cmd.MarkFlagRequired("id") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") @@ -266,7 +266,7 @@ 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(&id, "id", "", "Resource ID of the Business Hours resource.") + cmd.Flags().StringVar(&id, "id", "", "Resource ID of the Business Hour.") cmd.MarkFlagRequired("id") businessHourCmd.AddCommand(cmd) } diff --git a/cmd/cc/call_monitoring.go b/cmd/cc/call_monitoring.go index fc3f359..b79c2e8 100644 --- a/cmd/cc/call_monitoring.go +++ b/cmd/cc/call_monitoring.go @@ -212,4 +212,27 @@ func init() { callMonitoringCmd.AddCommand(cmd) } + { // whisper-coach-request + var interactionId string + cmd := &cobra.Command{ + Use: "whisper-coach-request", + Short: "Whisper Coach Request", + Long: `This feature is currently in Beta. Contact your Cisco team if you want access to this feature. + +Create a Whisper Coach request for the supervisor to coach the agent on a call that is being monitored already. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/v1/monitor/{interactionId}/coach") + req.PathParam("interactionId", interactionId) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&interactionId, "interaction-id", "", "The unique ID representing the monitored interaction that the supervisor needs to coach.") + cmd.MarkFlagRequired("interaction-id") + callMonitoringCmd.AddCommand(cmd) + } + } diff --git a/cmd/cc/campaign_group.go b/cmd/cc/campaign_group.go new file mode 100644 index 0000000..07aa7e5 --- /dev/null +++ b/cmd/cc/campaign_group.go @@ -0,0 +1,65 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package cc + +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 campaignGroupCmd = &cobra.Command{ + Use: "campaign-group", + Short: "CampaignGroup commands", +} + +func init() { + cmd.CcCmd.AddCommand(campaignGroupCmd) + + { // list + var campaignGroupName string + var page string + var pageSize string + var campaignStatus string + cmd := &cobra.Command{ + Use: "list", + Short: "List Campaigns by Campaign Group", + Long: "Retrieves the list of campaigns that belong to the specified campaign group. Results are paginated and can optionally be filtered by campaign status.\n\n**Note:** The `campaignStatus` filter is case-insensitive. Allowed values are `Draft`, `Running`, `Pending`, `Paused`, `Completed`, `Ended`. Unknown values will result in a 400 response.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/v3/campaign-management/campaign-groups/{campaignGroupName}/campaigns") + req.PathParam("campaignGroupName", campaignGroupName) + req.QueryParam("page", page) + req.QueryParam("pageSize", pageSize) + req.QueryParam("campaignStatus", campaignStatus) + 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(&campaignGroupName, "campaign-group-name", "", "The name of the campaign group whose campaigns are to be retrieved. Case-insensitive matching. **Allowed characters:** - `A-Z`, `a-z`, `0-9`, `_` (underscore), space **Allowed Length** `1..64`") + cmd.MarkFlagRequired("campaign-group-name") + cmd.Flags().StringVar(&page, "page", "", "The page number of the result set to retrieve (1-based).") + cmd.Flags().StringVar(&pageSize, "page-size", "", "The number of campaigns to return per page. Must be between 1 and 100.") + cmd.Flags().StringVar(&campaignStatus, "campaign-status", "", "Optional filter for campaign status. Case-insensitive. Allowed values: `Draft`, `Running`, `Pending`, `Paused`, `Completed`, `Ended`.") + campaignGroupCmd.AddCommand(cmd) + } + +} diff --git a/cmd/cc/campaign_manager.go b/cmd/cc/campaign_manager.go index 3ced42b..cc16a83 100644 --- a/cmd/cc/campaign_manager.go +++ b/cmd/cc/campaign_manager.go @@ -59,17 +59,6 @@ func init() { { // update-request var campaignId string - var dialingRate float64 - var dialingListFetchUrl string - var outdialAni string - var campaignName string - var authToken string - var noAnswerRingLimit int64 - var maxDialingRate float64 - var reservationPercentage int64 - var previewOfferTimeout int64 - var previewOfferTimeoutAutoAction string - var previewActionsDisabled []string var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -85,18 +74,6 @@ func init() { } } else if bodyRaw != "" { req.SetBodyRaw(bodyRaw) - } else { - req.BodyFloat("dialingRate", dialingRate, cmd.Flags().Changed("dialing-rate")) - req.BodyString("dialingListFetchURL", dialingListFetchUrl) - req.BodyString("outdialANI", outdialAni) - req.BodyString("campaignName", campaignName) - req.BodyString("authToken", authToken) - req.BodyInt("noAnswerRingLimit", noAnswerRingLimit, cmd.Flags().Changed("no-answer-ring-limit")) - req.BodyFloat("maxDialingRate", maxDialingRate, cmd.Flags().Changed("max-dialing-rate")) - req.BodyInt("reservationPercentage", reservationPercentage, cmd.Flags().Changed("reservation-percentage")) - req.BodyInt("previewOfferTimeout", previewOfferTimeout, cmd.Flags().Changed("preview-offer-timeout")) - req.BodyString("previewOfferTimeoutAutoAction", previewOfferTimeoutAutoAction) - req.BodyStringSlice("previewActionsDisabled", previewActionsDisabled) } resp, statusCode, err := req.Do() if err != nil { @@ -107,17 +84,6 @@ func init() { } cmd.Flags().StringVar(&campaignId, "campaign-id", "", "The unique request id of the campaign that needs to be updated") cmd.MarkFlagRequired("campaign-id") - cmd.Flags().Float64Var(&dialingRate, "dialing-rate", 0, "") - cmd.Flags().StringVar(&dialingListFetchUrl, "dialing-list-fetch-url", "", "") - cmd.Flags().StringVar(&outdialAni, "outdial-ani", "", "") - cmd.Flags().StringVar(&campaignName, "campaign-name", "", "") - cmd.Flags().StringVar(&authToken, "auth-token", "", "") - cmd.Flags().Int64Var(&noAnswerRingLimit, "no-answer-ring-limit", 0, "") - cmd.Flags().Float64Var(&maxDialingRate, "max-dialing-rate", 0, "") - cmd.Flags().Int64Var(&reservationPercentage, "reservation-percentage", 0, "") - cmd.Flags().Int64Var(&previewOfferTimeout, "preview-offer-timeout", 0, "") - cmd.Flags().StringVar(&previewOfferTimeoutAutoAction, "preview-offer-timeout-auto-action", "", "") - cmd.Flags().StringSliceVar(&previewActionsDisabled, "preview-actions-disabled", nil, "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") campaignManagerCmd.AddCommand(cmd) @@ -144,4 +110,44 @@ func init() { campaignManagerCmd.AddCommand(cmd) } + { // get-valid-times + var orgid string + var campaignId string + var interactionId string + var agentId string + var trackingId string + cmd := &cobra.Command{ + Use: "get-valid-times", + Short: "Get Valid Campaign Times", + Long: `Gets valid campaign times for a campaign and agent. This request is accepted for asynchronous processing. Requires 'cjp:user','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, "GET", "/v1/organization/{orgid}/getValidCampaignTimes") + req.PathParam("orgid", orgid) + req.QueryParam("campaignId", campaignId) + req.QueryParam("interactionId", interactionId) + req.QueryParam("agentId", agentId) + req.QueryParam("trackingId", trackingId) + 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", "", "The organization ID for which valid campaign times are being requested.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&campaignId, "campaign-id", "", "The campaign ID for which valid campaign times are being requested.") + cmd.Flags().StringVar(&interactionId, "interaction-id", "", "The unique identifier of the interaction associated with this request.") + cmd.Flags().StringVar(&agentId, "agent-id", "", "The agent ID for whom valid campaign times are being requested.") + cmd.Flags().StringVar(&trackingId, "tracking-id", "", "Optional tracking identifier for request tracing.") + campaignManagerCmd.AddCommand(cmd) + } + } diff --git a/cmd/cc/captures.go b/cmd/cc/captures.go index 50c2479..2dd70ba 100644 --- a/cmd/cc/captures.go +++ b/cmd/cc/captures.go @@ -31,7 +31,7 @@ func init() { cmd := &cobra.Command{ Use: "list", Short: "List Captures", - Long: `Retrieve a list of Captures given a set of task IDs`, + Long: "Retrieve a list of Captures given a set of task IDs.\n\n### Captures Availability\n\nNot all tasks will have captures by default and they will be available based on the organization's configurations and retention policy. Querying closed tasks is recommended, as open tasks may return incomplete data.\n\nTranscripts retrieved through this API are post-interaction artifacts.\n- For voice, transcripts are available when at least one transcript based configuration/feature is enabled such as Auto CSAT, Agent Well Being, Call Drop Summary, Topics Analytics.\n\n- For digital channels such as Chat, Email, Social, Work Item, and Custom Messaging, transcripts are generated from the conversation messages. Please refer [guide for digital transcripts](/docs/guide-for-digital-transcripts) for more details\n\n### URL Expiry\n\nThe maximum duration of validity of pre signed URL or default value when no value is passed for urlExpiration is 60 minutes.\n\n### Authentication & Authorization\n\nThis API requires a valid bearer token. The caller must satisfy the scope and role requirements for one of the following:\n\n#### Service App\n- **Required Scope:** `cjp:config_read`\n- The `orgId` must be provided in the request body and must match the token's org.\n- For service app setup, refer to [Contact Center Service Apps](/docs/contact-center-service-apps).\n\n#### Org Admin\n- **Required Scopes:** `Identity:SCIM` and `Identity:Organization`\n- **Required Role (one of):** `id_full_admin`, `id_readonly_admin`, `cjp.admin`, or `atlas-portal.partner.provision_admin`\n- The user must belong to the organization being queried. If `orgId` is provided in the request body, it must match the token's org. If `orgId` is omitted, it is inferred from the token.\n\n#### Partner Admin\n- **Required Scope:** `Identity:SCIM` for the managed org\n- **Required Role:** `atlas-portal.partner.salesadmin`\n- The org ID must be included in the managed org list. This is accomplished by adding the org to the `Managed customer orgs` list in control hub.\n\n#### Supervisor\n- **Required Role:** `cjp.supervisor`\n- The user must belong to the organization being queried. If `orgId` is provided in the request body, it must match the token's org. If `orgId` is omitted, it is inferred from the token.\n\n**Note:** Please refer to the contact center setup documentation for the configuration details.\n\n", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/v1/captures/query") if bodyFile != "" { diff --git a/cmd/cc/channel.go b/cmd/cc/channel.go new file mode 100644 index 0000000..76788af --- /dev/null +++ b/cmd/cc/channel.go @@ -0,0 +1,319 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package cc + +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 channelCmd = &cobra.Command{ + Use: "channel", + Short: "Channel commands", +} + +func init() { + cmd.CcCmd.AddCommand(channelCmd) + + { // create + var orgid string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "create", + Short: "Create a new Channel", + Long: `Create a new Channel in a given organization. Supports custom channels for work items.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/channel") + 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") + channelCmd.AddCommand(cmd) + } + + { // bulk-save + var orgid string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "bulk-save", + Short: "Bulk save Channels", + Long: `Create, Update or delete Channels in bulk in a given organization.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/channel/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") + channelCmd.AddCommand(cmd) + } + + { // get-id + var orgid string + var id string + var includeLogoUrlVersioned string + cmd := &cobra.Command{ + Use: "get-id", + Short: "Get specific Channel by ID", + Long: `Retrieve an existing Channel by ID in a given organization. Set includeLogoUrlVersioned to true to include logoUrlVersioned in the response.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/channel/{id}") + req.PathParam("orgid", orgid) + req.PathParam("id", id) + req.QueryParam("includeLogoUrlVersioned", includeLogoUrlVersioned) + 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 Channel") + cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&includeLogoUrlVersioned, "include-logo-url-versioned", "", "Include logoUrlVersioned in the response.") + channelCmd.AddCommand(cmd) + } + + { // update-id + var orgid string + var id string + cmd := &cobra.Command{ + Use: "update-id", + Short: "Update specific Channel by ID", + Long: `Update an existing Channel by ID in a given organization.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/channel/{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 Channel") + cmd.MarkFlagRequired("id") + channelCmd.AddCommand(cmd) + } + + { // delete-id + var orgid string + var id string + cmd := &cobra.Command{ + Use: "delete-id", + Short: "Delete specific Channel by ID", + Long: `Delete an existing Channel by ID in a given organization.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/channel/{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 Channel") + cmd.MarkFlagRequired("id") + channelCmd.AddCommand(cmd) + } + + { // patch-id + var orgid string + var id string + var description string + var logoType string + var logoIconName string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "patch-id", + Short: "Partially update Channel by ID", + Long: `Partially update a channel by ID. Only the supplied fields are changed; absent fields retain their current values. Patchable fields: name, description, logoType (MOMENTUM only), logoIconName. logoUrl and logoUrlVersioned cannot be changed by using PATCH; use PUT to update the logo image. channelType cannot be changed after creation. in a given organization.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "PATCH", "/organization/{orgid}/channel/{id}") + 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) + } else { + req.BodyString("description", description) + req.BodyString("logoType", logoType) + req.BodyString("logoIconName", logoIconName) + } + 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 Channel") + cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&description, "description", "", "") + cmd.Flags().StringVar(&logoType, "logo-type", "", "") + cmd.Flags().StringVar(&logoIconName, "logo-icon-name", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + channelCmd.AddCommand(cmd) + } + + { // list-references + 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 Channel", + Long: `Retrieve a list of all entities that have reference to an existing Channel by ID in a given organization. Includes Asset and Entry Point entities that reference the channel.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/channel/{id}/incoming-references") + req.PathParam("orgid", orgid) + req.PathParam("id", id) + req.QueryParam("type", typeVal) + 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(&id, "id", "", "ID of this contact center resource.") + cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&typeVal, "type", "", "Entity type of the other entity that has a reference to this specific entity.") + 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.") + channelCmd.AddCommand(cmd) + } + + { // list + var orgid string + var filter string + var attributes string + var search string + var page string + var pageSize string + var sort string + var includeCount string + var singleObjectResponse string + var includeLogoUrlVersioned string + cmd := &cobra.Command{ + Use: "list", + Short: "List Channels", + Long: `Retrieve a list of Channels in a given organization. Supports pagination metadata. Set includeLogoUrlVersioned to true to include logoUrlVersioned in the response. 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/channel") + req.PathParam("orgid", orgid) + req.QueryParam("filter", filter) + req.QueryParam("attributes", attributes) + req.QueryParam("search", search) + req.QueryParam("page", page) + req.QueryParam("pageSize", pageSize) + req.QueryParam("sort", sort) + req.QueryParam("includeCount", includeCount) + req.QueryParam("singleObjectResponse", singleObjectResponse) + req.QueryParam("includeLogoUrlVersioned", includeLogoUrlVersioned) + 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", "", "Filter expression") + cmd.Flags().StringVar(&attributes, "attributes", "", "Supported attributes") + 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(&sort, "sort", "", "Sortable properties") + cmd.Flags().StringVar(&includeCount, "include-count", "", "If set to true, the API response includes the asset count.") + cmd.Flags().StringVar(&singleObjectResponse, "single-object-response", "", "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.") + cmd.Flags().StringVar(&includeLogoUrlVersioned, "include-logo-url-versioned", "", "Include logoUrlVersioned in the response.") + channelCmd.AddCommand(cmd) + } + +} diff --git a/cmd/cc/contact_list_management.go b/cmd/cc/contact_list_management.go index 1b91bc6..a923ea4 100644 --- a/cmd/cc/contact_list_management.go +++ b/cmd/cc/contact_list_management.go @@ -143,7 +143,7 @@ func init() { cmd.MarkFlagRequired("campaign-id") cmd.Flags().StringVar(&contactListId, "contact-list-id", "", "Contact List ID (as a number string).") cmd.MarkFlagRequired("contact-list-id") - cmd.Flags().StringVar(&contactId, "contact-id", "", "Contact Unique ID (Customer Unique ID or Account Unique ID or Contact_Phone)") + cmd.Flags().StringVar(&contactId, "contact-id", "", "Contact Unique ID (Contact Phone or Customer Unique ID or Account Unique ID)") cmd.MarkFlagRequired("contact-id") cmd.Flags().StringVar(&contactStatus, "contact-status", "", "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") @@ -198,9 +198,9 @@ func init() { cmd := &cobra.Command{ Use: "get-within-campaign", Short: "Get Contact Lists within a Campaign", - Long: `Retrieves all contact lists within a campaign, with optional filters for status and source.`, + Long: "Retrieves all contact lists within a campaign. Use the optional `status` and `source` query parameters to filter results.\n\nEach contact list in the response includes the source file name, the time contact counts were last updated, and a breakdown of contact counts by processing and dialer status (for example, processed, invalid, valid, eligible, fresh, open, closed, and ready for dialer).\n\nResponses may reflect the same data for up to 30 seconds when the same campaign and filters are requested repeatedly.", RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/v3/campaign-management/campaigns/{campaignId}/contact-lists") + req := client.NewRequest(config.CcBaseURL, "GET", "/v4/campaign-management/campaigns/{campaignId}/contact-lists") req.PathParam("campaignId", campaignId) req.QueryParam("status", status) req.QueryParam("source", source) @@ -221,7 +221,56 @@ func init() { cmd.Flags().StringVar(&campaignId, "campaign-id", "", "Campaign ID.") cmd.MarkFlagRequired("campaign-id") cmd.Flags().StringVar(&status, "status", "", "Contact List Status filter (Active, Expired, UploadFailed, etc.)") - cmd.Flags().StringVar(&source, "source", "", "Contact List Source filter (API, SFTP, ManualFile, GlobalUpload, GlobalSFTP)") + cmd.Flags().StringVar(&source, "source", "", "Contact List Source filter (API, SFTP, ManualFile)") + contactListManagementCmd.AddCommand(cmd) + } + + { // update-status-across-campaign-chain + var campaignId string + var contactId string + var contactListId string + var fields string + var contactStatus string + var searchAcrossTheCampaignChain string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update-status-across-campaign-chain", + Short: "Update contact status across the campaign chain", + Long: "Synchronously closes the specified contacts and returns the outcome in the same response. Contacts are identified using the same unique identifiers configured in your campaign field mappings, such as Contact Phone (format as per the associated field mapping) or Customer Unique ID or Account Unique ID (For more info, please refer to the [global variables help documentation](https://docs-campaign-for-contact-centers.webexcampaign.com/docs/global-variables)).\n\n By default, the API searches the specified campaign and any of its downstream target campaigns in the chain (across all active contact-lists associated with these campaigns), and closes the contact wherever it is found in a closeable state. Set `searchAcrossTheCampaignChain` to `no` to close the contact only in the campaign specified in the request path.\n\n**Optional query parameters**\n\n- `contactListId` - Search only the specific contact-list within the campaign specified in the request path. If `searchAcrossTheCampaignChain` is set to `yes` then all active contact-lists in the other downstream target campaigns in the chain are also searched.\n- `fields` - Return specified contact field values in the response for the matching contact records (for example: FirstName, LastName, AmountDue).", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "PATCH", "/v3/campaign-management/campaigns/{campaignId}/contacts/{contactId}") + req.PathParam("campaignId", campaignId) + req.PathParam("contactId", contactId) + req.QueryParam("contactListId", contactListId) + req.QueryParam("fields", fields) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("contactStatus", contactStatus) + req.BodyString("searchAcrossTheCampaignChain", searchAcrossTheCampaignChain) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&campaignId, "campaign-id", "", "Campaign ID (as a string). All downstream target campaigns in the chain are included in the search.") + cmd.MarkFlagRequired("campaign-id") + cmd.Flags().StringVar(&contactId, "contact-id", "", "Contact Unique ID (Contact Phone or Customer Unique ID or Account Unique ID)") + cmd.MarkFlagRequired("contact-id") + cmd.Flags().StringVar(&contactListId, "contact-list-id", "", "Optional. Search only the specific contact-list within the campaign specified in the request path. If `searchAcrossTheCampaignChain` is set to `yes`, then all active contact-lists in the other downstream target campaigns in the chain are also searched. When omitted, all active contact lists in that campaign are searched.") + cmd.Flags().StringVar(&fields, "fields", "", "Optional. Contact field names to include in the response (comma-separated names).") + cmd.Flags().StringVar(&contactStatus, "contact-status", "", "") + cmd.Flags().StringVar(&searchAcrossTheCampaignChain, "search-across-the-campaign-chain", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") contactListManagementCmd.AddCommand(cmd) } diff --git a/cmd/cc/contact_service_queue.go b/cmd/cc/contact_service_queue.go index 293e429..4f72445 100644 --- a/cmd/cc/contact_service_queue.go +++ b/cmd/cc/contact_service_queue.go @@ -41,9 +41,9 @@ func init() { var singleObjectResponse string cmd := &cobra.Command{ Use: "list", - Short: "List Contact Service Queue(s)", - Long: `Retrieve a list of Contact Service Queue(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.`, + Short: "List Contact Service Queues", + Long: `Retrieve a list of Contact Service Queues in a given organization. + 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. Deprecated. Use GET /v2/contact-service-queue instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v3/contact-service-queue") req.PathParam("orgid", orgid) @@ -77,8 +77,8 @@ func init() { 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 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.") + cmd.Flags().StringVar(&provisioningView, "provisioning-view", "", "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.") + cmd.Flags().StringVar(&singleObjectResponse, "single-object-response", "", "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.") contactServiceQueueCmd.AddCommand(cmd) } @@ -120,8 +120,8 @@ func init() { var bodyFile string cmd := &cobra.Command{ Use: "bulk-save", - Short: "Bulk save Contact Service Queue(s)", - Long: `Create, Update or delete Contact Service Queue(s) in bulk in a given organization.`, + Short: "Bulk save Contact Service Queues", + Long: `Create, Update or delete Contact Service Queues in bulk in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/contact-service-queue/v2/bulk") req.PathParam("orgid", orgid) @@ -152,8 +152,8 @@ func init() { var bodyFile string cmd := &cobra.Command{ Use: "bulk-partial-update", - Short: "Bulk partial update Contact Service Queue(s)", - Long: `Update some or all properties for multiple Contact Service Queue(s) in bulk in a given organization.`, + Short: "Bulk partial update Contact Service Queues", + Long: `Update some or all properties for multiple Contact Service Queues in bulk in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PATCH", "/organization/{orgid}/contact-service-queue/bulk") req.PathParam("orgid", orgid) @@ -215,13 +215,13 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // list-skill-csqs-skill-profile + { // list-skill-based-skill-profile-id var orgid string var id string cmd := &cobra.Command{ - 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.`, + Use: "list-skill-based-skill-profile-id", + Short: "List skill-based Contact Service Queues by skill profile ID (public)", + Long: `Retrieve a list of skill-based Contact Service Queues associated with a given skill profile ID, accessible to authorized clients 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-csq-references + { // delete-references var orgid string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "delete-csq-references", - Short: "Delete CSQ References", - Long: `Delete references for Contact Service Queues in a given organization.`, + Use: "delete-references", + Short: "Delete references from Contact Service Queues", + Long: `Removes the references to the specified entities (such as teams, sites, or agents) from Contact Service Queues for 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,23 +272,23 @@ func init() { 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.Flags().StringVar(&orgid, "orgid", "", "") 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-manually-assignable-csqs + { // list-manually-assignable var orgid string var agentId string var teamId string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "list-manually-assignable-csqs", - Short: "List Manually Assignable CSQs", - Long: `Retrieve manually assignable Contact Service Queues in a given organization.`, + Use: "list-manually-assignable", + Short: "List manually assignable Contact Service Queues", + Long: `Retrieve a list of Contact Service Queues that are eligible for manual contact assignment based on the provided criteria 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) @@ -323,8 +323,8 @@ func init() { var nextStartId string cmd := &cobra.Command{ Use: "purge-inactive", - Short: "Purge inactive Contact Service Queue(s)", - Long: `Purge inactive Contact Service Queue(s) older than the configured interval for a given organization.`, + Short: "Purge inactive Contact Service Queues", + Long: `Purge inactive Contact Service Queues older than the configured interval for a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/contact-service-queue/purge-inactive-entities") req.PathParam("orgid", orgid) @@ -338,7 +338,7 @@ 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(&nextStartId, "next-start-id", "", "This is the entity ID from which items for the next purge batch with be selected.") + cmd.Flags().StringVar(&nextStartId, "next-start-id", "", "This is the entity ID from which items for the next purge batch will be selected.") contactServiceQueueCmd.AddCommand(cmd) } @@ -438,15 +438,15 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // list-csq-references-id + { // list-references var orgid string var id string var typeVal string var page string var pageSize string cmd := &cobra.Command{ - Use: "list-csq-references-id", - Short: "List CSQ References by ID", + Use: "list-references", + Short: "List references for a specific Contact Service Queue", 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") @@ -479,16 +479,16 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // list-agent-based + { // list-agent-based-user-id var orgid string var userid string var search string var page string var pageSize string 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.`, + Use: "list-agent-based-user-id", + Short: "List agent-based Contact Service Queues by user ID", + Long: `Retrieve a list of agent-based Contact Service Queues 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) @@ -520,16 +520,16 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // list-skill-based + { // list-skill-based-user-id var orgid string var userid string var search string var page string var pageSize string 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.`, + Use: "list-skill-based-user-id", + Short: "List skill-based Contact Service Queues by user ID", + Long: `Retrieve a list of skill-based Contact Service Queues 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) @@ -561,16 +561,16 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // list-team-based + { // list-team-based-user-id var orgid string var userid string var search string var page string 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.`, + Use: "list-team-based-user-id", + Short: "List team-based Contact Service Queues by user ID", + Long: `Retrieve a list of team-based Contact Service Queues 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) @@ -612,7 +612,7 @@ func init() { cmd := &cobra.Command{ Use: "create-remove-agents-users-agent", Short: "Add or remove agents/users to/from an agent based queue", - Long: `This API can be used by a contact center supervisor to add or remove agents to/from an agent based queue that they have access to by virtue of their user profile access rights. Additionally, the request payload should contain the user id(s) managed by the supervisor.`, + Long: `This API can be used by a contact center supervisor to add or remove agents to or from an agent-based queue that they can access through their user profile access rights. Additionally, the request payload should contain the user ID(s) managed by the supervisor.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/v2/contact-service-queue/{id}/reassign-agents") req.PathParam("orgid", orgid) @@ -783,14 +783,14 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // list-csqs-skills-profile + { // list-skill-based-dynamic-skills-skill-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.`, + Use: "list-skill-based-dynamic-skills-skill-profile", + Short: "List skill-based Contact Service Queues by dynamic skills and skill profile", + Long: `Retrieve a list of skill-based Contact Service Queues that match the given dynamic skills and skill profile criteria 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) @@ -815,14 +815,14 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // list-csqs-user-profile + { // list-skill-based-skill-profile-id-user-id 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.`, + Use: "list-skill-based-skill-profile-id-user-id", + Short: "List skill-based Contact Service Queues by skill profile ID and user ID", + Long: `Retrieve a list of skill-based Contact Service Queues associated with the given skill profile ID and user ID combination 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) diff --git a/cmd/cc/data_sources.go b/cmd/cc/data_sources.go index 2f878b9..95b5e1a 100644 --- a/cmd/cc/data_sources.go +++ b/cmd/cc/data_sources.go @@ -39,7 +39,7 @@ func init() { cmd := &cobra.Command{ Use: "register", Short: "Register a Data Source", - Long: "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.", + Long: "Register a data source with the Webex BYODS system. Authenticate using a Service App with the `spark-admin:datasource_write` scope.\nSchema IDs determine the types of data Webex sends to the DAP and the expected responses. Use the Data Source Schemas endpoints to inspect the available schemas.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/dataSources") if bodyFile != "" { @@ -78,7 +78,7 @@ func init() { cmd := &cobra.Command{ Use: "get-all", Short: "Retrieve All Data Sources", - Long: "Show all data sources registered for this Service App with the scope `spark-admin:datasource_read`.", + Long: "Lists all data sources registered by the Service App. Requires the `spark-admin:datasource_read` scope.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/dataSources") if config.Paginate() { @@ -102,7 +102,7 @@ func init() { cmd := &cobra.Command{ Use: "get-schemas", Short: "Retrieve Data Source Schemas", - Long: `Show available schemas. No specific scope is needed to retrieve the dataSource schemas, but a valid API token should be presented.`, + Long: `Lists the available data source schemas. A valid API access token is required, but no specific scope is needed.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/dataSources/schemas") if config.Paginate() { @@ -127,7 +127,7 @@ func init() { cmd := &cobra.Command{ Use: "get-schema", Short: "Retrieve Details of a Specific Data Source Schema", - Long: `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.`, + Long: `Retrieves details for a specific data source schema by schema ID. A valid API access token is required, but no specific scope is needed.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/dataSources/schemas/{schemaId}") req.PathParam("schemaId", schemaId) @@ -155,7 +155,7 @@ func init() { cmd := &cobra.Command{ Use: "delete", Short: "Delete a Data Source", - Long: "Delete a Data Source, by Data Source ID.\n\nSpecify the Data Source ID in the `dataSourceId` parameter in the URI.", + Long: "Deletes a data source by ID.\n\nSpecify the data source ID in the `dataSourceId` URI parameter.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/dataSources/{dataSourceId}") req.PathParam("dataSourceId", dataSourceId) @@ -166,7 +166,7 @@ func init() { return output.Print(resp, statusCode) }, } - cmd.Flags().StringVar(&dataSourceId, "data-source-id", "", "The unique identifier for the dataSource.") + cmd.Flags().StringVar(&dataSourceId, "data-source-id", "", "The unique identifier for the data source.") cmd.MarkFlagRequired("data-source-id") dataSourcesCmd.AddCommand(cmd) } @@ -176,7 +176,7 @@ func init() { cmd := &cobra.Command{ Use: "get", Short: "Retrieve Data Source Details", - Long: "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.", + Long: "Retrieves details for a data source by ID. Use a Service App token with the `spark-admin:datasource_read` scope.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/dataSources/{dataSourceId}") req.PathParam("dataSourceId", dataSourceId) @@ -194,7 +194,7 @@ func init() { return output.Print(resp, statusCode) }, } - cmd.Flags().StringVar(&dataSourceId, "data-source-id", "", "The unique identifier for the dataSource.") + cmd.Flags().StringVar(&dataSourceId, "data-source-id", "", "The unique identifier for the data source.") cmd.MarkFlagRequired("data-source-id") dataSourcesCmd.AddCommand(cmd) } @@ -214,7 +214,7 @@ func init() { cmd := &cobra.Command{ Use: "update", Short: "Update a Data Source", - Long: "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.", + Long: "Updates a data source. The fields you can update are `audience`, `subject`, `nonce`, `url`, and `tokenLifetimeMinutes`.\nYou can set `status` from `active` to `disabled` only if you provide an `errorMessage`, which may be shown to the customer administrator in Control Hub.\nUpdate tokens before they expire to prevent service interruption.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/dataSources/{dataSourceId}") req.PathParam("dataSourceId", dataSourceId) diff --git a/cmd/cc/desktop_layout.go b/cmd/cc/desktop_layout.go index 0825aaa..f901b60 100644 --- a/cmd/cc/desktop_layout.go +++ b/cmd/cc/desktop_layout.go @@ -412,7 +412,7 @@ func init() { Use: "list", Short: "List Desktop Layout(s)", Long: `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. - 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/desktop-layout") req.PathParam("orgid", orgid) diff --git a/cmd/cc/desktop_profile.go b/cmd/cc/desktop_profile.go index dbd92de..d538665 100644 --- a/cmd/cc/desktop_profile.go +++ b/cmd/cc/desktop_profile.go @@ -37,11 +37,12 @@ func init() { var page string var pageSize string var singleObjectResponse string + var provisioningView string cmd := &cobra.Command{ Use: "list", - Short: "List Desktop Profile(s)", - Long: `Retrieve a list of Desktop 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.`, + Short: "List Desktop Profiles", + Long: `Retrieve a list of Desktop Profiles in a given organization. + 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/agent-profile") req.PathParam("orgid", orgid) @@ -51,6 +52,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 { @@ -67,17 +69,69 @@ 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, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, 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 ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ") + cmd.Flags().StringVar(&filter, "filter", "", "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 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 ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ") 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(&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(&singleObjectResponse, "single-object-response", "", "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.") + cmd.Flags().StringVar(&provisioningView, "provisioning-view", "", "If set to true, the API will only return data that the user has access to, according to the User Profile.") desktopProfileCmd.AddCommand(cmd) } { // create var orgid string + var accessBuddyTeam string + var accessEntryPoint string + var accessIdleCode string + var accessQueue string + var accessWrapUpCode string + var active string + var agentDnvalidation string + var name string + var parentType string + var viewableStatistics string + var organizationId string + var id string + var version string + var description string + var siteId string + var screenPopup string + var lastAgentRouting string + var scheduleAndManageCallBack string + var autoWrapUp string + var autoAnswer string + var agentPersonalGreeting string + var autoWrapAfterSeconds string + var agentAvailableAfterOutdial string + var allowAutoWrapUpExtension string + var wrapUpCodes string + var idleCodes string + var queues string + var entryPoints string + var buddyTeams string + var consultToQueue string + var outdialEnabled string + var outdialEntryPointId string + var outdialAniid string + var addressBookId string + var dialPlanEnabled string + var dialPlans string + var agentDnvalidationCriteria string + var agentDnvalidationCriterions string + var loginVoiceOptions string + var thresholdRules string + var timeoutDesktopInactivityCustomEnabled string + var showUserDetailsMs string + var stateSynchronizationMs string + var showUserDetailsWebex string + var stateSynchronizationWebex string + var manageChannelAvailability string + var timeoutDesktopInactivityMins string + var systemDefault string + var createdTime string + var lastUpdatedTime string + var autoAcceptDigitalInteractions string var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -87,6 +141,57 @@ func init() { RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/agent-profile") req.PathParam("orgid", orgid) + req.QueryParam("accessBuddyTeam", accessBuddyTeam) + req.QueryParam("accessEntryPoint", accessEntryPoint) + req.QueryParam("accessIdleCode", accessIdleCode) + req.QueryParam("accessQueue", accessQueue) + req.QueryParam("accessWrapUpCode", accessWrapUpCode) + req.QueryParam("active", active) + req.QueryParam("agentDNValidation", agentDnvalidation) + req.QueryParam("name", name) + req.QueryParam("parentType", parentType) + req.QueryParam("viewableStatistics", viewableStatistics) + req.QueryParam("organizationId", organizationId) + req.QueryParam("id", id) + req.QueryParam("version", version) + req.QueryParam("description", description) + req.QueryParam("siteId", siteId) + req.QueryParam("screenPopup", screenPopup) + req.QueryParam("lastAgentRouting", lastAgentRouting) + req.QueryParam("scheduleAndManageCallBack", scheduleAndManageCallBack) + req.QueryParam("autoWrapUp", autoWrapUp) + req.QueryParam("autoAnswer", autoAnswer) + req.QueryParam("agentPersonalGreeting", agentPersonalGreeting) + req.QueryParam("autoWrapAfterSeconds", autoWrapAfterSeconds) + req.QueryParam("agentAvailableAfterOutdial", agentAvailableAfterOutdial) + req.QueryParam("allowAutoWrapUpExtension", allowAutoWrapUpExtension) + req.QueryParam("wrapUpCodes", wrapUpCodes) + req.QueryParam("idleCodes", idleCodes) + req.QueryParam("queues", queues) + req.QueryParam("entryPoints", entryPoints) + req.QueryParam("buddyTeams", buddyTeams) + req.QueryParam("consultToQueue", consultToQueue) + req.QueryParam("outdialEnabled", outdialEnabled) + req.QueryParam("outdialEntryPointId", outdialEntryPointId) + req.QueryParam("outdialANIId", outdialAniid) + req.QueryParam("addressBookId", addressBookId) + req.QueryParam("dialPlanEnabled", dialPlanEnabled) + req.QueryParam("dialPlans", dialPlans) + req.QueryParam("agentDNValidationCriteria", agentDnvalidationCriteria) + req.QueryParam("agentDNValidationCriterions", agentDnvalidationCriterions) + req.QueryParam("loginVoiceOptions", loginVoiceOptions) + req.QueryParam("thresholdRules", thresholdRules) + req.QueryParam("timeoutDesktopInactivityCustomEnabled", timeoutDesktopInactivityCustomEnabled) + req.QueryParam("showUserDetailsMS", showUserDetailsMs) + req.QueryParam("stateSynchronizationMS", stateSynchronizationMs) + req.QueryParam("showUserDetailsWebex", showUserDetailsWebex) + req.QueryParam("stateSynchronizationWebex", stateSynchronizationWebex) + req.QueryParam("manageChannelAvailability", manageChannelAvailability) + req.QueryParam("timeoutDesktopInactivityMins", timeoutDesktopInactivityMins) + req.QueryParam("systemDefault", systemDefault) + req.QueryParam("createdTime", createdTime) + req.QueryParam("lastUpdatedTime", lastUpdatedTime) + req.QueryParam("autoAcceptDigitalInteractions", autoAcceptDigitalInteractions) if bodyFile != "" { if err := req.SetBodyFile(bodyFile); err != nil { return err @@ -103,6 +208,57 @@ 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(&accessBuddyTeam, "access-buddy-team", "", "Agent profile configuration data") + cmd.Flags().StringVar(&accessEntryPoint, "access-entry-point", "", "Agent profile configuration data") + cmd.Flags().StringVar(&accessIdleCode, "access-idle-code", "", "Agent profile configuration data") + cmd.Flags().StringVar(&accessQueue, "access-queue", "", "Agent profile configuration data") + cmd.Flags().StringVar(&accessWrapUpCode, "access-wrap-up-code", "", "Agent profile configuration data") + cmd.Flags().StringVar(&active, "active", "", "Agent profile configuration data") + cmd.Flags().StringVar(&agentDnvalidation, "agent-dnvalidation", "", "Agent profile configuration data") + cmd.Flags().StringVar(&name, "name", "", "Agent profile configuration data") + cmd.Flags().StringVar(&parentType, "parent-type", "", "Agent profile configuration data") + cmd.Flags().StringVar(&viewableStatistics, "viewable-statistics", "", "Agent profile configuration data") + cmd.Flags().StringVar(&organizationId, "organization-id", "", "Agent profile configuration data") + cmd.Flags().StringVar(&id, "id", "", "Agent profile configuration data") + cmd.Flags().StringVar(&version, "version", "", "Agent profile configuration data") + cmd.Flags().StringVar(&description, "description", "", "Agent profile configuration data") + cmd.Flags().StringVar(&siteId, "site-id", "", "Agent profile configuration data") + cmd.Flags().StringVar(&screenPopup, "screen-popup", "", "Agent profile configuration data") + cmd.Flags().StringVar(&lastAgentRouting, "last-agent-routing", "", "Agent profile configuration data") + cmd.Flags().StringVar(&scheduleAndManageCallBack, "schedule-and-manage-call-back", "", "Agent profile configuration data") + cmd.Flags().StringVar(&autoWrapUp, "auto-wrap-up", "", "Agent profile configuration data") + cmd.Flags().StringVar(&autoAnswer, "auto-answer", "", "Agent profile configuration data") + cmd.Flags().StringVar(&agentPersonalGreeting, "agent-personal-greeting", "", "Agent profile configuration data") + cmd.Flags().StringVar(&autoWrapAfterSeconds, "auto-wrap-after-seconds", "", "Agent profile configuration data") + cmd.Flags().StringVar(&agentAvailableAfterOutdial, "agent-available-after-outdial", "", "Agent profile configuration data") + cmd.Flags().StringVar(&allowAutoWrapUpExtension, "allow-auto-wrap-up-extension", "", "Agent profile configuration data") + cmd.Flags().StringVar(&wrapUpCodes, "wrap-up-codes", "", "Agent profile configuration data") + cmd.Flags().StringVar(&idleCodes, "idle-codes", "", "Agent profile configuration data") + cmd.Flags().StringVar(&queues, "queues", "", "Agent profile configuration data") + cmd.Flags().StringVar(&entryPoints, "entry-points", "", "Agent profile configuration data") + cmd.Flags().StringVar(&buddyTeams, "buddy-teams", "", "Agent profile configuration data") + cmd.Flags().StringVar(&consultToQueue, "consult-to-queue", "", "Agent profile configuration data") + cmd.Flags().StringVar(&outdialEnabled, "outdial-enabled", "", "Agent profile configuration data") + cmd.Flags().StringVar(&outdialEntryPointId, "outdial-entry-point-id", "", "Agent profile configuration data") + cmd.Flags().StringVar(&outdialAniid, "outdial-aniid", "", "Agent profile configuration data") + cmd.Flags().StringVar(&addressBookId, "address-book-id", "", "Agent profile configuration data") + cmd.Flags().StringVar(&dialPlanEnabled, "dial-plan-enabled", "", "Agent profile configuration data") + cmd.Flags().StringVar(&dialPlans, "dial-plans", "", "Agent profile configuration data") + cmd.Flags().StringVar(&agentDnvalidationCriteria, "agent-dnvalidation-criteria", "", "Agent profile configuration data") + cmd.Flags().StringVar(&agentDnvalidationCriterions, "agent-dnvalidation-criterions", "", "Agent profile configuration data") + cmd.Flags().StringVar(&loginVoiceOptions, "login-voice-options", "", "Agent profile configuration data") + cmd.Flags().StringVar(&thresholdRules, "threshold-rules", "", "Agent profile configuration data") + cmd.Flags().StringVar(&timeoutDesktopInactivityCustomEnabled, "timeout-desktop-inactivity-custom-enabled", "", "Agent profile configuration data") + cmd.Flags().StringVar(&showUserDetailsMs, "show-user-details-ms", "", "Agent profile configuration data") + cmd.Flags().StringVar(&stateSynchronizationMs, "state-synchronization-ms", "", "Agent profile configuration data") + cmd.Flags().StringVar(&showUserDetailsWebex, "show-user-details-webex", "", "Agent profile configuration data") + cmd.Flags().StringVar(&stateSynchronizationWebex, "state-synchronization-webex", "", "Agent profile configuration data") + cmd.Flags().StringVar(&manageChannelAvailability, "manage-channel-availability", "", "Agent profile configuration data") + cmd.Flags().StringVar(&timeoutDesktopInactivityMins, "timeout-desktop-inactivity-mins", "", "Agent profile configuration data") + cmd.Flags().StringVar(&systemDefault, "system-default", "", "Agent profile configuration data") + cmd.Flags().StringVar(&createdTime, "created-time", "", "Agent profile configuration data") + cmd.Flags().StringVar(&lastUpdatedTime, "last-updated-time", "", "Agent profile configuration data") + cmd.Flags().StringVar(&autoAcceptDigitalInteractions, "auto-accept-digital-interactions", "", "Agent profile configuration data") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") desktopProfileCmd.AddCommand(cmd) @@ -114,8 +270,8 @@ func init() { var bodyFile string cmd := &cobra.Command{ Use: "bulk-save", - Short: "Bulk save Desktop Profile(s)", - Long: `Create, Update or delete Desktop Profile(s) in bulk in a given organization.`, + Short: "Bulk save Desktop Profiles", + Long: `Create, Update or delete Desktop Profiles in bulk in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/agent-profile/bulk") req.PathParam("orgid", orgid) @@ -179,8 +335,8 @@ func init() { var nextStartId string cmd := &cobra.Command{ Use: "purge-inactive", - Short: "Purge inactive Desktop Profile(s)", - Long: `Purge inactive Desktop Profile(s) older than the configured interval for a given organization.`, + Short: "Purge inactive Desktop Profiles", + Long: `Purge inactive Desktop Profiles older than the configured interval for a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/agent-profile/purge-inactive-entities") req.PathParam("orgid", orgid) @@ -194,7 +350,7 @@ 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(&nextStartId, "next-start-id", "", "This is the entity ID from which items for the next purge batch with be selected.") + cmd.Flags().StringVar(&nextStartId, "next-start-id", "", "This is the entity ID from which items for the next purge batch will be selected.") desktopProfileCmd.AddCommand(cmd) } @@ -233,6 +389,56 @@ func init() { { // update-id var orgid string var id string + var accessBuddyTeam string + var accessEntryPoint string + var accessIdleCode string + var accessQueue string + var accessWrapUpCode string + var active string + var agentDnvalidation string + var name string + var parentType string + var viewableStatistics string + var organizationId string + var version string + var description string + var siteId string + var screenPopup string + var lastAgentRouting string + var scheduleAndManageCallBack string + var autoWrapUp string + var autoAnswer string + var agentPersonalGreeting string + var autoWrapAfterSeconds string + var agentAvailableAfterOutdial string + var allowAutoWrapUpExtension string + var wrapUpCodes string + var idleCodes string + var queues string + var entryPoints string + var buddyTeams string + var consultToQueue string + var outdialEnabled string + var outdialEntryPointId string + var outdialAniid string + var addressBookId string + var dialPlanEnabled string + var dialPlans string + var agentDnvalidationCriteria string + var agentDnvalidationCriterions string + var loginVoiceOptions string + var thresholdRules string + var timeoutDesktopInactivityCustomEnabled string + var showUserDetailsMs string + var stateSynchronizationMs string + var showUserDetailsWebex string + var stateSynchronizationWebex string + var manageChannelAvailability string + var timeoutDesktopInactivityMins string + var systemDefault string + var createdTime string + var lastUpdatedTime string + var autoAcceptDigitalInteractions string var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -243,6 +449,57 @@ func init() { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/agent-profile/{id}") req.PathParam("orgid", orgid) req.PathParam("id", id) + req.QueryParam("accessBuddyTeam", accessBuddyTeam) + req.QueryParam("accessEntryPoint", accessEntryPoint) + req.QueryParam("accessIdleCode", accessIdleCode) + req.QueryParam("accessQueue", accessQueue) + req.QueryParam("accessWrapUpCode", accessWrapUpCode) + req.QueryParam("active", active) + req.QueryParam("agentDNValidation", agentDnvalidation) + req.QueryParam("name", name) + req.QueryParam("parentType", parentType) + req.QueryParam("viewableStatistics", viewableStatistics) + req.QueryParam("organizationId", organizationId) + req.QueryParam("id", id) + req.QueryParam("version", version) + req.QueryParam("description", description) + req.QueryParam("siteId", siteId) + req.QueryParam("screenPopup", screenPopup) + req.QueryParam("lastAgentRouting", lastAgentRouting) + req.QueryParam("scheduleAndManageCallBack", scheduleAndManageCallBack) + req.QueryParam("autoWrapUp", autoWrapUp) + req.QueryParam("autoAnswer", autoAnswer) + req.QueryParam("agentPersonalGreeting", agentPersonalGreeting) + req.QueryParam("autoWrapAfterSeconds", autoWrapAfterSeconds) + req.QueryParam("agentAvailableAfterOutdial", agentAvailableAfterOutdial) + req.QueryParam("allowAutoWrapUpExtension", allowAutoWrapUpExtension) + req.QueryParam("wrapUpCodes", wrapUpCodes) + req.QueryParam("idleCodes", idleCodes) + req.QueryParam("queues", queues) + req.QueryParam("entryPoints", entryPoints) + req.QueryParam("buddyTeams", buddyTeams) + req.QueryParam("consultToQueue", consultToQueue) + req.QueryParam("outdialEnabled", outdialEnabled) + req.QueryParam("outdialEntryPointId", outdialEntryPointId) + req.QueryParam("outdialANIId", outdialAniid) + req.QueryParam("addressBookId", addressBookId) + req.QueryParam("dialPlanEnabled", dialPlanEnabled) + req.QueryParam("dialPlans", dialPlans) + req.QueryParam("agentDNValidationCriteria", agentDnvalidationCriteria) + req.QueryParam("agentDNValidationCriterions", agentDnvalidationCriterions) + req.QueryParam("loginVoiceOptions", loginVoiceOptions) + req.QueryParam("thresholdRules", thresholdRules) + req.QueryParam("timeoutDesktopInactivityCustomEnabled", timeoutDesktopInactivityCustomEnabled) + req.QueryParam("showUserDetailsMS", showUserDetailsMs) + req.QueryParam("stateSynchronizationMS", stateSynchronizationMs) + req.QueryParam("showUserDetailsWebex", showUserDetailsWebex) + req.QueryParam("stateSynchronizationWebex", stateSynchronizationWebex) + req.QueryParam("manageChannelAvailability", manageChannelAvailability) + req.QueryParam("timeoutDesktopInactivityMins", timeoutDesktopInactivityMins) + req.QueryParam("systemDefault", systemDefault) + req.QueryParam("createdTime", createdTime) + req.QueryParam("lastUpdatedTime", lastUpdatedTime) + req.QueryParam("autoAcceptDigitalInteractions", autoAcceptDigitalInteractions) if bodyFile != "" { if err := req.SetBodyFile(bodyFile); err != nil { return err @@ -261,6 +518,56 @@ func init() { cmd.MarkFlagRequired("orgid") cmd.Flags().StringVar(&id, "id", "", "Resource ID of the Desktop Profile.") cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&accessBuddyTeam, "access-buddy-team", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&accessEntryPoint, "access-entry-point", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&accessIdleCode, "access-idle-code", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&accessQueue, "access-queue", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&accessWrapUpCode, "access-wrap-up-code", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&active, "active", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&agentDnvalidation, "agent-dnvalidation", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&name, "name", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&parentType, "parent-type", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&viewableStatistics, "viewable-statistics", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&organizationId, "organization-id", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&version, "version", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&description, "description", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&siteId, "site-id", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&screenPopup, "screen-popup", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&lastAgentRouting, "last-agent-routing", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&scheduleAndManageCallBack, "schedule-and-manage-call-back", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&autoWrapUp, "auto-wrap-up", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&autoAnswer, "auto-answer", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&agentPersonalGreeting, "agent-personal-greeting", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&autoWrapAfterSeconds, "auto-wrap-after-seconds", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&agentAvailableAfterOutdial, "agent-available-after-outdial", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&allowAutoWrapUpExtension, "allow-auto-wrap-up-extension", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&wrapUpCodes, "wrap-up-codes", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&idleCodes, "idle-codes", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&queues, "queues", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&entryPoints, "entry-points", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&buddyTeams, "buddy-teams", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&consultToQueue, "consult-to-queue", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&outdialEnabled, "outdial-enabled", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&outdialEntryPointId, "outdial-entry-point-id", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&outdialAniid, "outdial-aniid", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&addressBookId, "address-book-id", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&dialPlanEnabled, "dial-plan-enabled", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&dialPlans, "dial-plans", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&agentDnvalidationCriteria, "agent-dnvalidation-criteria", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&agentDnvalidationCriterions, "agent-dnvalidation-criterions", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&loginVoiceOptions, "login-voice-options", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&thresholdRules, "threshold-rules", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&timeoutDesktopInactivityCustomEnabled, "timeout-desktop-inactivity-custom-enabled", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&showUserDetailsMs, "show-user-details-ms", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&stateSynchronizationMs, "state-synchronization-ms", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&showUserDetailsWebex, "show-user-details-webex", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&stateSynchronizationWebex, "state-synchronization-webex", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&manageChannelAvailability, "manage-channel-availability", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&timeoutDesktopInactivityMins, "timeout-desktop-inactivity-mins", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&systemDefault, "system-default", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&createdTime, "created-time", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&lastUpdatedTime, "last-updated-time", "", "Agent profile configuration data for update") + cmd.Flags().StringVar(&autoAcceptDigitalInteractions, "auto-accept-digital-interactions", "", "Agent profile configuration data for update") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") desktopProfileCmd.AddCommand(cmd) diff --git a/cmd/cc/dial_plan.go b/cmd/cc/dial_plan.go index 8277eaf..00704ec 100644 --- a/cmd/cc/dial_plan.go +++ b/cmd/cc/dial_plan.go @@ -36,8 +36,10 @@ func init() { var pageSize string cmd := &cobra.Command{ Use: "list", - Short: "List Dial Plan(s)", - Long: `Retrieve a list of Dial Plan(s) in a given organization.`, + Short: "List Dial Plans", + Long: `Retrieve a list of Dial Plans in a given organization. + +**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/dial-plan") req.PathParam("orgid", orgid) @@ -62,8 +64,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(&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.") @@ -82,12 +84,16 @@ func init() { var prefix string var strippedChars string var systemDefault bool + var createdTime int64 + var lastUpdatedTime int64 var bodyRaw string var bodyFile string cmd := &cobra.Command{ Use: "create", Short: "Create a new Dial Plan", - Long: `Create a new Dial Plan in a given organization.`, + Long: `Create a new Dial Plan in a given organization. + +**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/dial-plan") req.PathParam("orgid", orgid) @@ -108,6 +114,8 @@ func init() { req.BodyString("prefix", prefix) req.BodyString("strippedChars", strippedChars) 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 { @@ -128,6 +136,8 @@ func init() { cmd.Flags().StringVar(&prefix, "prefix", "", "") cmd.Flags().StringVar(&strippedChars, "stripped-chars", "", "") 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") dialPlanCmd.AddCommand(cmd) @@ -139,8 +149,10 @@ func init() { var bodyFile string cmd := &cobra.Command{ Use: "bulk-save", - Short: "Bulk save Dial Plan(s)", - Long: `Create, Update or delete Dial Plan(s) in bulk in a given organization.`, + Short: "Bulk save Dial Plans", + Long: `Create, Update or delete Dial Plans in bulk in a given organization. + +**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/dial-plan/bulk") req.PathParam("orgid", orgid) @@ -205,7 +217,9 @@ func init() { cmd := &cobra.Command{ Use: "get-id", Short: "Get specific Dial Plan by ID", - Long: `Retrieve an existing Dial Plan by ID in a given organization.`, + Long: `Retrieve an existing Dial Plan by ID in a given organization. + +**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/dial-plan/{id}") req.PathParam("orgid", orgid) @@ -243,12 +257,16 @@ func init() { var prefix string var strippedChars string var systemDefault bool + var createdTime int64 + var lastUpdatedTime int64 var bodyRaw string var bodyFile string cmd := &cobra.Command{ Use: "update-id", Short: "Update specific Dial Plan by ID", - Long: `Update an existing Dial Plan by ID in a given organization.`, + Long: `Update an existing Dial Plan by ID in a given organization. + +**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/dial-plan/{id}") req.PathParam("orgid", orgid) @@ -270,6 +288,8 @@ func init() { req.BodyString("prefix", prefix) req.BodyString("strippedChars", strippedChars) 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 { @@ -291,6 +311,8 @@ func init() { cmd.Flags().StringVar(&prefix, "prefix", "", "") cmd.Flags().StringVar(&strippedChars, "stripped-chars", "", "") 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") dialPlanCmd.AddCommand(cmd) @@ -302,7 +324,9 @@ func init() { cmd := &cobra.Command{ Use: "delete-id", Short: "Delete specific Dial Plan by ID", - Long: `Delete an existing Dial Plan by ID in a given organization.`, + Long: `Delete an existing Dial Plan by ID in a given organization. + +**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/dial-plan/{id}") req.PathParam("orgid", orgid) @@ -330,7 +354,9 @@ func init() { cmd := &cobra.Command{ Use: "list-references", Short: "List references for a specific Dial Plan", - Long: `Retrieve a list of all entities that have reference to an existing Dial Plan by ID in a given organization.`, + Long: `Retrieve a list of all entities that have reference to an existing Dial Plan by ID in a given organization. + +**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/dial-plan/{id}/incoming-references") req.PathParam("orgid", orgid) diff --git a/cmd/cc/events.go b/cmd/cc/events.go new file mode 100644 index 0000000..e24182d --- /dev/null +++ b/cmd/cc/events.go @@ -0,0 +1,86 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package cc + +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 eventsCmd = &cobra.Command{ + Use: "events", + Short: "Events commands", +} + +func init() { + cmd.CcCmd.AddCommand(eventsCmd) + + { // list-specifications + var orgid string + cmd := &cobra.Command{ + Use: "list-specifications", + Short: "List Event Specifications", + Long: "List the event types available for use in `event_flows[]`. Each entry describes the event name, payload schema, and any contextual metadata bound when the event fires.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/event-specifications") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + 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.") + cmd.MarkFlagRequired("orgid") + eventsCmd.AddCommand(cmd) + } + + { // list-specifications-2 + var orgid string + cmd := &cobra.Command{ + Use: "list-specifications-2", + Short: "List Event Specifications", + Long: "List the event types available for use in `event_flows[]`. Each entry describes the event name, payload schema, and any contextual metadata bound when the event fires.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/event-specifications") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + 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.") + cmd.MarkFlagRequired("orgid") + eventsCmd.AddCommand(cmd) + } + +} diff --git a/cmd/cc/external_data_updates.go b/cmd/cc/external_data_updates.go new file mode 100644 index 0000000..88990e7 --- /dev/null +++ b/cmd/cc/external_data_updates.go @@ -0,0 +1,62 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package cc + +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 externalDataUpdatesCmd = &cobra.Command{ + Use: "external-data-updates", + Short: "ExternalDataUpdates commands", +} + +func init() { + cmd.CcCmd.AddCommand(externalDataUpdatesCmd) + + { // update-task-global-variables + var xOrganizationId string + var trackingId string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update-task-global-variables", + Short: "Update Task Global Variables", + Long: `Updates numeric global variable values associated with a completed Webex Contact Center task. The request must identify the organization and task along with its start and end timestamps. The task should have ended within two days prior to the time of making the request.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "PUT", "/v1/data/updateExternal") + req.Header("X-ORGANIZATION-ID", xOrganizationId) + req.Header("TrackingId", trackingId) + 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(&xOrganizationId, "x-organization-id", "", "Organization identifier used for partner or delegated access.") + cmd.Flags().StringVar(&trackingId, "tracking-id", "", "Optional identifier used for request traceability, debugging, and error reporting.") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + externalDataUpdatesCmd.AddCommand(cmd) + } + +} diff --git a/cmd/cc/flows.go b/cmd/cc/flows.go new file mode 100644 index 0000000..d935f92 --- /dev/null +++ b/cmd/cc/flows.go @@ -0,0 +1,985 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package cc + +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 flowsCmd = &cobra.Command{ + Use: "flows", + Short: "Flows commands", +} + +func init() { + cmd.CcCmd.AddCommand(flowsCmd) + + { // list + var orgid string + var flowType string + var ids string + var page string + var partialNameSearch string + var searchBy string + var size string + var includePagination string + var isValidation string + cmd := &cobra.Command{ + Use: "list", + Short: "List Flows or Subflows", + Long: "Returns a list of flows in response. Channel-based filtering can be applied with the `searchBy` query parameter (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`). Channel visibility may be constrained by organization feature flags.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/flows") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.QueryParam("flowType", flowType) + req.QueryParam("ids", ids) + req.QueryParam("ids", ids) + req.QueryParam("page", page) + req.QueryParam("partialNameSearch", partialNameSearch) + req.QueryParam("searchBy", searchBy) + req.QueryParam("size", size) + req.QueryParam("includePagination", includePagination) + req.QueryParam("isValidation", isValidation) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + cmd.Flags().StringVar(&ids, "ids", "", "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.") + cmd.Flags().StringVar(&page, "page", "", "Defines the number of the displayed page. The page number starts from 0.") + cmd.Flags().StringVar(&partialNameSearch, "partial-name-search", "", "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.") + cmd.Flags().StringVar(&searchBy, "search-by", "", "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).") + cmd.Flags().StringVar(&size, "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(&includePagination, "include-pagination", "", "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\".") + cmd.Flags().StringVar(&isValidation, "is-validation", "", "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.") + flowsCmd.AddCommand(cmd) + } + + { // publish + var orgid string + var flowId string + var skipValidation string + var flowType string + var trackingId string + var comment string + var tagIds []string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "publish", + Short: "Publish a Flow or Subflow", + Long: "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`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/flows/{flowId}:publish") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("skipValidation", skipValidation) + req.QueryParam("flowType", flowType) + req.Header("TrackingId", trackingId) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("comment", comment) + req.BodyStringSlice("tagIds", tagIds) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&skipValidation, "skip-validation", "", "If true, the flow's pre-publish validation is skipped. Use with care.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + cmd.Flags().StringVar(&trackingId, "tracking-id", "", "ID for tracking.") + cmd.Flags().StringVar(&comment, "comment", "", "") + cmd.Flags().StringSliceVar(&tagIds, "tag-ids", nil, "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + flowsCmd.AddCommand(cmd) + } + + { // lock + var orgid string + var flowId string + var flowType string + cmd := &cobra.Command{ + Use: "lock", + Short: "Lock a Flow or Subflow", + Long: "Lock a flow to prevent concurrent edits by other users. Locks expire after 15 minutes of inactivity.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/flows/{flowId}:lock") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("flowType", flowType) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + flowsCmd.AddCommand(cmd) + } + + { // unlock + var orgid string + var flowId string + var flowType string + cmd := &cobra.Command{ + Use: "unlock", + Short: "Unlock a Flow or Subflow", + Long: "Release the lock on a flow to allow other users to edit it.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/flows/{flowId}:unlock") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("flowType", flowType) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + flowsCmd.AddCommand(cmd) + } + + { // validate + var orgid string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "validate", + Short: "Validate a Flow", + Long: "Dry-run validate a flow definition without persisting it. Use this to check correctness before importing.\n\nNote: validation is more lenient than import. A flow that passes `:validate` can still be rejected by `:import` (for example, a missing start activity), so a successful validation does not guarantee a successful import.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/v2/flows:validate") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + flowsCmd.AddCommand(cmd) + } + + { // import + var orgid string + var overwrite string + var flowType string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "import", + Short: "Import a Flow", + Long: "Import a new flow from a flow definition. Creates the flow in draft state and returns the assigned flow metadata, including `flowId`.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/v2/flows:import") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.QueryParam("overwrite", overwrite) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&overwrite, "overwrite", "", "If true, replaces an existing flow with the same name. Defaults to false.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + flowsCmd.AddCommand(cmd) + } + + { // get + var orgid string + var flowId string + var flowType string + cmd := &cobra.Command{ + Use: "get", + Short: "Get a Flow", + Long: "Retrieve the current draft of a flow as a flow document. To fetch a specific published version, use the `:export` endpoint.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/flows/{flowId}") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "Flow ID.") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + flowsCmd.AddCommand(cmd) + } + + { // save-draft + var orgid string + var flowId string + var expectedVersion string + var flowType string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "save-draft", + Short: "Save a Flow Draft", + Long: "Save a complete flow document as the current draft, replacing the existing draft. Pass `expectedVersion` as a query parameter to enable optimistic locking; the request fails with `409 Conflict` if the server-side version does not match. Omit `expectedVersion` to skip the check.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/v2/flows/{flowId}") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("expectedVersion", expectedVersion) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "Flow ID.") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&expectedVersion, "expected-version", "", "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + flowsCmd.AddCommand(cmd) + } + + { // patch-draft + var orgid string + var flowId string + var expectedVersion string + var flowType string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "patch-draft", + Short: "Patch a Flow Draft", + Long: "Apply partial updates to an existing flow draft without replacing the entire document. The patch body is a Patch Draft Contract \u2014 server-side merge, idempotent, and re-validated after the merge. The patch is rejected if the merged document fails validation, so the draft is never left in a broken state. The body may also include top-level overrides such as `name` and `description`.\n\nPass `expectedVersion` as a query parameter to enable optimistic locking; the request fails with `409 Conflict` if the server-side version does not match. Omit `expectedVersion` to skip the check.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "PATCH", "/flow-store/{orgid}/project/{projectId}/v2/flows/{flowId}") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("expectedVersion", expectedVersion) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "Flow ID.") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&expectedVersion, "expected-version", "", "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + flowsCmd.AddCommand(cmd) + } + + { // validate-draft + var orgid string + var flowId string + var versionId string + var flowType string + cmd := &cobra.Command{ + Use: "validate-draft", + Short: "Validate an Existing Flow Draft", + Long: "Validate the current draft of an existing flow (read-only operation).\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/flows/{flowId}:validate") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("versionId", versionId) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&versionId, "version-id", "", "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + flowsCmd.AddCommand(cmd) + } + + { // export + var orgid string + var flowId string + var version string + var flowType string + cmd := &cobra.Command{ + Use: "export", + Short: "Export a Flow", + Long: "Export a flow as a flow document for backup, migration, or version control.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/flows/{flowId}:export") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("version", version) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&version, "version", "", "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + flowsCmd.AddCommand(cmd) + } + + { // list-2 + var orgid string + var flowType string + var ids string + var page string + var partialNameSearch string + var searchBy string + var size string + var includePagination string + var isValidation string + cmd := &cobra.Command{ + Use: "list-2", + Short: "List Flows or Subflows", + Long: "Returns a list of flows in response. Channel-based filtering can be applied with the `searchBy` query parameter (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`). Channel visibility may be constrained by organization feature flags. If associatedChannels key is missing or empty, it will be treated as telephony flow.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/flows") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.QueryParam("flowType", flowType) + req.QueryParam("ids", ids) + req.QueryParam("ids", ids) + req.QueryParam("page", page) + req.QueryParam("partialNameSearch", partialNameSearch) + req.QueryParam("searchBy", searchBy) + req.QueryParam("size", size) + req.QueryParam("includePagination", includePagination) + req.QueryParam("isValidation", isValidation) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + cmd.Flags().StringVar(&ids, "ids", "", "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.") + cmd.Flags().StringVar(&page, "page", "", "Defines the number of the displayed page. The page number starts from 0.") + cmd.Flags().StringVar(&partialNameSearch, "partial-name-search", "", "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.") + cmd.Flags().StringVar(&searchBy, "search-by", "", "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).") + cmd.Flags().StringVar(&size, "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(&includePagination, "include-pagination", "", "If set 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\".") + cmd.Flags().StringVar(&isValidation, "is-validation", "", "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.") + flowsCmd.AddCommand(cmd) + } + + { // publish-2 + var orgid string + var flowId string + var skipValidation string + var flowType string + var trackingId string + var comment string + var tagIds []string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "publish-2", + Short: "Publish a Flow or Subflow", + Long: "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_write`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/flows/{flowId}:publish") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("skipValidation", skipValidation) + req.QueryParam("flowType", flowType) + req.Header("TrackingId", trackingId) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("comment", comment) + req.BodyStringSlice("tagIds", tagIds) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&skipValidation, "skip-validation", "", "If true, the flow's pre-publish validation is skipped. Use with care.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + cmd.Flags().StringVar(&trackingId, "tracking-id", "", "ID for tracking.") + cmd.Flags().StringVar(&comment, "comment", "", "") + cmd.Flags().StringSliceVar(&tagIds, "tag-ids", nil, "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + flowsCmd.AddCommand(cmd) + } + + { // lock-2 + var orgid string + var flowId string + var flowType string + cmd := &cobra.Command{ + Use: "lock-2", + Short: "Lock a Flow or Subflow", + Long: "Lock a flow to prevent concurrent edits by other users. Locks expire after 15 minutes of inactivity.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/flows/{flowId}:lock") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("flowType", flowType) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + flowsCmd.AddCommand(cmd) + } + + { // unlock-2 + var orgid string + var flowId string + var flowType string + cmd := &cobra.Command{ + Use: "unlock-2", + Short: "Unlock a Flow or Subflow", + Long: "Release the lock on a flow to allow other users to edit it.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/flows/{flowId}:unlock") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("flowType", flowType) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + flowsCmd.AddCommand(cmd) + } + + { // validate-2 + var orgid string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "validate-2", + Short: "Validate a Flow or Subflow", + Long: "Dry-run validate a flow/subflow definition without persisting it. Use this to check correctness before importing. Include `associatedChannels` to preserve the channel metadata that import and export payloads round-trip. Validation requests where `associatedChannels` is missing or empty are treated as telephony flows, and dry-run validation does not derive the effective channel from `associatedChannels`.\n\nNote: validation is more lenient than import. A flow that passes `:validate` can still be rejected by `:import` (for example, a missing start activity), so a successful validation does not guarantee a successful import.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/v2/flows:validate") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + flowsCmd.AddCommand(cmd) + } + + { // import-2 + var orgid string + var overwrite string + var flowType string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "import-2", + Short: "Import a Flow or Subflow", + Long: "Import a new flow/subflow from a flow definition. Creates the flow/subflow in draft state and returns the assigned flow metadata, including `flowId`. Include `associatedChannels` in the payload when the flow contains channel-specific activities (for example, `customMessaging`) so channel references can be resolved correctly during import. If `associatedChannels` is missing or empty, the import is treated as a telephony flow. For `FLOW` imports, blank or whitespace-only `associatedChannels[].channelType` values are rejected.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/v2/flows:import") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.QueryParam("overwrite", overwrite) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&overwrite, "overwrite", "", "If true, replaces an existing flow with the same name. Defaults to false.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + flowsCmd.AddCommand(cmd) + } + + { // get-2 + var orgid string + var flowId string + var flowType string + cmd := &cobra.Command{ + Use: "get-2", + Short: "Get a Flow or Subflow", + Long: "Retrieve the current draft of a flow/subflow as a flow document. To fetch a specific published version, use the `:export` endpoint. The response includes channel metadata (for example, `associatedChannels`) used by channel-specific activities such as `customMessaging`. If `associatedChannels` is missing or empty, the flow is treated as telephony.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/flows/{flowId}") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "Flow ID.") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + flowsCmd.AddCommand(cmd) + } + + { // save-draft-2 + var orgid string + var flowId string + var expectedVersion string + var flowType string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "save-draft-2", + Short: "Save a Flow or Subflow Draft", + Long: "Save a complete flow/subflow document as the current draft, replacing the existing draft. Submitted `associatedChannels` values are not persisted on save; the draft preserves the existing stored channel metadata. Omitting `associatedChannels` does not default an existing flow to telephony. Pass `expectedVersion` as a query parameter to enable optimistic locking; the request fails with `409 Conflict` if the server-side version does not match. Omit `expectedVersion` to skip the check.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/v2/flows/{flowId}") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("expectedVersion", expectedVersion) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "Flow ID.") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&expectedVersion, "expected-version", "", "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + flowsCmd.AddCommand(cmd) + } + + { // patch-draft-2 + var orgid string + var flowId string + var expectedVersion string + var flowType string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "patch-draft-2", + Short: "Patch a Flow or Subflow Draft", + Long: "Apply partial updates to an existing flow/subflow draft without replacing the entire document. The patch body is a Patch Draft Contract \u2014 server-side merge, idempotent, and re-validated after the merge. The patch is rejected if the merged document fails validation, so the draft is never left in a broken state. The body may also include top-level overrides such as `name` and `description`. Submitted `associatedChannels` values are not persisted on patch; the draft preserves the existing stored channel metadata.\n\nPass `expectedVersion` as a query parameter to enable optimistic locking; the request fails with `409 Conflict` if the server-side version does not match. Omit `expectedVersion` to skip the check.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "PATCH", "/{orgid}/project/{projectId}/v2/flows/{flowId}") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("expectedVersion", expectedVersion) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "Flow ID.") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&expectedVersion, "expected-version", "", "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + flowsCmd.AddCommand(cmd) + } + + { // validate-draft-2 + var orgid string + var flowId string + var versionId string + var flowType string + cmd := &cobra.Command{ + Use: "validate-draft-2", + Short: "Validate an Existing Flow or Subflow Draft", + Long: "Validate the current draft of an existing flow/subflow (read-only operation). Validation reads the draft as stored. Drafts where `associatedChannels` is missing or empty are treated as telephony flows, and validation does not derive the effective channel from `associatedChannels`.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/flows/{flowId}:validate") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("versionId", versionId) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&versionId, "version-id", "", "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + flowsCmd.AddCommand(cmd) + } + + { // export-2 + var orgid string + var flowId string + var version string + var flowType string + cmd := &cobra.Command{ + Use: "export-2", + Short: "Export a Flow or Subflow", + Long: "Export a flow/subflow as a flow document for backup, migration, or version control. The exported payload includes `associatedChannels` metadata to preserve channel-specific activity behavior (for example, `customMessaging`) during re-import. If `associatedChannels` is missing or empty, the flow is treated as telephony.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/flows/{flowId}:export") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("version", version) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&version, "version", "", "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + flowsCmd.AddCommand(cmd) + } + + { // search + var orgid string + var query string + var flowType string + var page string + var size string + var keyValueFilter string + cmd := &cobra.Command{ + Use: "search", + Short: "Search Flows", + Long: "Returns a list of flows in response. The search is case-sensitive.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/flows:search") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.QueryParam("query", query) + req.QueryParam("flowType", flowType) + req.QueryParam("page", page) + req.QueryParam("size", size) + req.QueryParam("keyValueFilter", keyValueFilter) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&query, "query", "", "Searches for flows with the given query. The search is case-sensitive.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW' or 'ALL'. Default value is 'ALL'.") + cmd.Flags().StringVar(&page, "page", "", "Defines the number of the displayed page. The page number starts from 0.") + cmd.Flags().StringVar(&size, "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(&keyValueFilter, "key-value-filter", "", "Filters results based on key-value pairs. Format: 'key1|value1,key2|value2'. This will add a filter on normalizedFlow collection directly instead of running query on atlas.") + flowsCmd.AddCommand(cmd) + } + + { // delete + var orgid string + var flowId string + var force string + var skipRsEpcheck string + var flowType string + cmd := &cobra.Command{ + Use: "delete", + Short: "Delete a Flow or Subflow", + Long: "Permanently deletes a flow or subflow. Flows deleted via this API are removed permanently and cannot be recovered.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "DELETE", "/{orgid}/project/{projectId}/flows/{flowId}") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("force", force) + req.QueryParam("skipRsEPCheck", skipRsEpcheck) + req.QueryParam("flowType", flowType) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "ID of the flow/subflow to delete.") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&force, "force", "", "If 'yes', the flow is deleted even if it is still referenced by other entities. Defaults to 'no'.") + cmd.Flags().StringVar(&skipRsEpcheck, "skip-rs-epcheck", "", "If true, skips the check for routing strategy and entry point associations before deleting the flow.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + flowsCmd.AddCommand(cmd) + } + +} diff --git a/cmd/cc/functions.go b/cmd/cc/functions.go new file mode 100644 index 0000000..9d0d723 --- /dev/null +++ b/cmd/cc/functions.go @@ -0,0 +1,458 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package cc + +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 functionsCmd = &cobra.Command{ + Use: "functions", + Short: "Functions commands", +} + +func init() { + cmd.CcCmd.AddCommand(functionsCmd) + + { // list-custom + var orgid string + var isPartialMatch string + var isCaseSensitive string + var name string + var language string + var status string + var sortBy string + var page string + var size string + var ids string + var fields string + var isValidation string + cmd := &cobra.Command{ + Use: "list-custom", + Short: "List Custom Functions", + Long: "List or search custom functions in the organization. Without filters, returns all custom functions. Supports filtering by name, language, and status, plus sorting and pagination.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/v1/{orgid}/functions") + req.PathParam("orgid", orgid) + req.QueryParam("isPartialMatch", isPartialMatch) + req.QueryParam("isCaseSensitive", isCaseSensitive) + req.QueryParam("name", name) + req.QueryParam("language", language) + req.QueryParam("status", status) + req.QueryParam("sortBy", sortBy) + req.QueryParam("page", page) + req.QueryParam("size", size) + req.QueryParam("ids", ids) + req.QueryParam("fields", fields) + req.QueryParam("isValidation", isValidation) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&isPartialMatch, "is-partial-match", "", "Whether to search with partial matches. If `false`, search/filter is based on exact match.") + cmd.Flags().StringVar(&isCaseSensitive, "is-case-sensitive", "", "Whether the search should be case-sensitive. Currently applicable only to the `name` field.") + cmd.Flags().StringVar(&name, "name", "", "Filter by function name.") + cmd.Flags().StringVar(&language, "language", "", "Filter by programming language.") + cmd.Flags().StringVar(&status, "status", "", "Filter by one or more function statuses (comma-separated, no spaces). Case-sensitive.") + cmd.Flags().StringVar(&sortBy, "sort-by", "", "Comma-separated fields with order. Supported fields (case-sensitive): `name`, `language`, `status`, `lastModifiedDate`. Prefix a field with `-` for descending order; no prefix means ascending.") + cmd.Flags().StringVar(&page, "page", "", "Zero-based page number for the paginated query.") + cmd.Flags().StringVar(&size, "size", "", "Number of results per page.") + cmd.Flags().StringVar(&ids, "ids", "", "Comma-separated list of function IDs to fetch.") + cmd.Flags().StringVar(&fields, "fields", "", "Comma-separated list of function fields to include in the response.") + cmd.Flags().StringVar(&isValidation, "is-validation", "", "Used by the Tenant Management team to validate the existence of functions with given IDs regardless of the user's RBAC access.") + functionsCmd.AddCommand(cmd) + } + + { // create-custom + var orgid string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "create-custom", + Short: "Create a Custom Function", + Long: "Create a new custom function. The source code is provided as an escaped string and the runtime defaults to the highest supported runtime for the given language.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/v1/{orgid}/functions") + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + functionsCmd.AddCommand(cmd) + } + + { // get-custom + var orgid string + var id string + var versionOrTag string + var metaDataOnly string + cmd := &cobra.Command{ + Use: "get-custom", + Short: "Get a Custom Function", + Long: "Retrieve a custom function by its ID. Use `versionOrTag` to fetch a specific published version, or omit it to get the draft.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/v1/{orgid}/functions/{id}") + req.PathParam("orgid", orgid) + req.PathParam("id", id) + req.QueryParam("versionOrTag", versionOrTag) + req.QueryParam("metaDataOnly", metaDataOnly) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&id, "id", "", "Custom function ID. Hexadecimal ObjectId returned by the create or list APIs.") + cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&versionOrTag, "version-or-tag", "", "Version number or publish tag of the source code to return (for example, `Dev`, `Live`, or `2`). If omitted, the draft version is returned.") + cmd.Flags().StringVar(&metaDataOnly, "meta-data-only", "", "If `true`, returns only metadata and excludes source code. If `false` or omitted, returns both metadata and source code.") + functionsCmd.AddCommand(cmd) + } + + { // update-custom + var orgid string + var id string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update-custom", + Short: "Update a Custom Function", + Long: "Update an existing custom function by ID. Replaces the draft source code and metadata with the supplied body.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "PUT", "/v1/{orgid}/functions/{id}") + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&id, "id", "", "Custom function ID.") + cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + functionsCmd.AddCommand(cmd) + } + + { // delete-custom + var orgid string + var id string + var isForceDeletion string + cmd := &cobra.Command{ + Use: "delete-custom", + Short: "Delete a Custom Function", + Long: "Delete a custom function by ID. Use `isForceDeletion=true` to delete even when the function is referenced by one or more flows.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "DELETE", "/v1/{orgid}/functions/{id}") + req.PathParam("orgid", orgid) + req.PathParam("id", id) + req.QueryParam("isForceDeletion", isForceDeletion) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&id, "id", "", "Custom function ID.") + cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&isForceDeletion, "is-force-deletion", "", "If `true`, deletes the function regardless of its usage in flows.") + functionsCmd.AddCommand(cmd) + } + + { // import-custom + var orgid string + var overwrite string + var associatedRcs string + cmd := &cobra.Command{ + Use: "import-custom", + Short: "Import a Custom Function", + Long: "Import a custom function from a previously exported function-definition JSON file, uploaded as the multipart `file` part (not a zip or base64 envelope). Use `overwrite=true` to replace any existing function with the same name.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/v1/{orgid}/functions:import") + req.PathParam("orgid", orgid) + req.QueryParam("overwrite", overwrite) + req.QueryParam("associatedRcs", associatedRcs) + req.QueryParam("associatedRcs", associatedRcs) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&overwrite, "overwrite", "", "If `true`, overwrites a function with the same name if one already exists.") + cmd.Flags().StringVar(&associatedRcs, "associated-rcs", "", "Optional list of associated routing-context IDs.") + functionsCmd.AddCommand(cmd) + } + + { // unlock-custom + var orgid string + var id string + cmd := &cobra.Command{ + Use: "unlock-custom", + Short: "Unlock a Custom Function", + Long: "Release the edit lock on a custom function so that other users can edit it.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/v1/{orgid}/functions/{id}:unlock") + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&id, "id", "", "") + cmd.MarkFlagRequired("id") + functionsCmd.AddCommand(cmd) + } + + { // lock-custom + var orgid string + var id string + cmd := &cobra.Command{ + Use: "lock-custom", + Short: "Lock a Custom Function", + Long: "Acquire an edit lock on a custom function to prevent concurrent writes by other users.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/v1/{orgid}/functions/{id}:lock") + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&id, "id", "", "") + cmd.MarkFlagRequired("id") + functionsCmd.AddCommand(cmd) + } + + { // test-custom + var orgid string + var id string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "test-custom", + Short: "Test a Custom Function", + Long: "Execute a custom function with a test payload. Implicitly publishes the latest draft first, so the run uses the most recent source code.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/v1/{orgid}/functions/{id}:test") + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&id, "id", "", "") + cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + functionsCmd.AddCommand(cmd) + } + + { // publish-custom + var orgid string + var id string + var tags []string + var comment string + var key_0 int64 + var key_1 float64 + var key_2 float64 + var key_3 float64 + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "publish-custom", + Short: "Publish a Custom Function", + Long: "Publish the latest draft of a custom function under one or more tags (`Dev`, `Test`, `Latest`, `Live`). Ensure the function has been created or updated before calling this API.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/v1/{orgid}/functions/{id}:publish") + 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) + } else { + req.BodyStringSlice("tags", tags) + req.BodyString("comment", comment) + req.BodyInt("key_0", key_0, cmd.Flags().Changed("key_0")) + req.BodyFloat("key_1", key_1, cmd.Flags().Changed("key_1")) + req.BodyFloat("key_2", key_2, cmd.Flags().Changed("key_2")) + req.BodyFloat("key_3", key_3, cmd.Flags().Changed("key_3")) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&id, "id", "", "") + cmd.MarkFlagRequired("id") + cmd.Flags().StringSliceVar(&tags, "tags", nil, "") + cmd.Flags().StringVar(&comment, "comment", "", "") + cmd.Flags().Int64Var(&key_0, "key_0", 0, "") + cmd.Flags().Float64Var(&key_1, "key_1", 0, "") + cmd.Flags().Float64Var(&key_2, "key_2", 0, "") + cmd.Flags().Float64Var(&key_3, "key_3", 0, "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + functionsCmd.AddCommand(cmd) + } + + { // export-custom + var orgid string + var id string + var versionOrTag string + cmd := &cobra.Command{ + Use: "export-custom", + Short: "Export a Custom Function", + Long: "Export a custom function for the given version or publish tag. Returns the plain function-definition JSON (name, language, runtime, description, source code, inputs, and outputs), suitable for re-importing via the import API.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/v1/{orgid}/functions/{id}:export") + req.PathParam("orgid", orgid) + req.PathParam("id", id) + req.QueryParam("versionOrTag", versionOrTag) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&id, "id", "", "") + cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&versionOrTag, "version-or-tag", "", "Version number or publish tag of the source code to export. If omitted, the latest published version is exported.") + functionsCmd.AddCommand(cmd) + } + + { // list-options + var orgid string + var language string + var runtime string + cmd := &cobra.Command{ + Use: "list-options", + Short: "List Function Options", + Long: "List the supported programming languages, runtimes, and corresponding wrapper code for custom functions. Filter by `language` or `runtime` to narrow the result.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/v1/{orgid}/functions/options") + req.PathParam("orgid", orgid) + req.QueryParam("language", language) + req.QueryParam("runtime", runtime) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&language, "language", "", "Filter by programming language (for example, `js`, `py`).") + cmd.Flags().StringVar(&runtime, "runtime", "", "Filter by runtime (for example, `nodejs22.x`, `python3.13`).") + functionsCmd.AddCommand(cmd) + } + +} diff --git a/cmd/cc/holiday_list.go b/cmd/cc/holiday_list.go index a9991c2..73a14ec 100644 --- a/cmd/cc/holiday_list.go +++ b/cmd/cc/holiday_list.go @@ -39,9 +39,9 @@ func init() { var singleObjectResponse string cmd := &cobra.Command{ Use: "list", - Short: "List Holiday List(s)", - Long: `Retrieve a list of Holiday List(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.`, + Short: "List Holiday Lists", + Long: `Retrieve a list of Holiday Lists in a given organization. + 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/holiday-list") req.PathParam("orgid", orgid) @@ -75,8 +75,8 @@ func init() { 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(&sort, "sort", "", "Sorting criteria in the format: property(, asc | desc). Default sort order is ascending. Supported sortable fields (name, createdTime, lastUpdatedTime). The examples below show some sort queries - name,asc - createdTime,desc ") - cmd.Flags().StringVar(&includeCount, "include-count", "", "Enable the flag to get the count of holidays") - 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(&includeCount, "include-count", "", "Enable this flag to get the count of holidays.") + cmd.Flags().StringVar(&singleObjectResponse, "single-object-response", "", "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.") holidayListCmd.AddCommand(cmd) } @@ -118,8 +118,8 @@ func init() { var bodyFile string cmd := &cobra.Command{ Use: "bulk-save", - Short: "Bulk save Holiday List(s)", - Long: `Create, Update or delete Holiday List(s) in bulk in a given organization.`, + Short: "Bulk save Holiday Lists", + Long: `Create, Update or delete Holiday Lists in bulk in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/holiday-list/bulk") req.PathParam("orgid", orgid) diff --git a/cmd/cc/legacy_flows.go b/cmd/cc/legacy_flows.go new file mode 100644 index 0000000..2e64750 --- /dev/null +++ b/cmd/cc/legacy_flows.go @@ -0,0 +1,98 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package cc + +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 legacyFlowsCmd = &cobra.Command{ + Use: "legacy-flows", + Short: "LegacyFlows commands", +} + +func init() { + cmd.CcCmd.AddCommand(legacyFlowsCmd) + + { // export + var orgid string + var flowId string + var version string + var flowType string + cmd := &cobra.Command{ + Use: "export", + Short: "Export a Flow or Subflow", + Long: "**Deprecated.** Use the Flow export endpoint (`GET /flow-store/{orgId}/project/{projectId}/v2/flows/{flowId}:export`, operationId `exportFlowV2`) instead. The V1 Flow APIs operate on the raw FDL format and will continue to function but will not receive new features.\n\nReturns the exported flow/subflow in response, including associated channel metadata used to preserve channel-specific activity behavior during export and re-import.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/flows/{flowId}:export") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("version", version) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&version, "version", "", "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + legacyFlowsCmd.AddCommand(cmd) + } + + { // import + var orgid string + var overwrite string + var flowType string + var contentLength string + cmd := &cobra.Command{ + Use: "import", + Short: "Import a Flow or Subflow", + Long: "**Deprecated.** Use the Flow import endpoint (`POST /flow-store/{orgId}/project/{projectId}/v2/flows:import`, operationId `importFlowV2`) instead. The V1 Flow APIs operate on the raw FDL format and will continue to function but will not receive new features.\n\nReturns the imported flow/subflow in response.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/flows:import") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.QueryParam("overwrite", overwrite) + req.QueryParam("flowType", flowType) + req.Header("Content-Length", contentLength) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&overwrite, "overwrite", "", "Determines whether to overwrite the existing flow or not. Possible values: yes/no.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + cmd.Flags().StringVar(&contentLength, "content-length", "", "Content length value in number of bytes.") + legacyFlowsCmd.AddCommand(cmd) + } + +} diff --git a/cmd/cc/notification.go b/cmd/cc/notification.go index 2e12b35..021081c 100644 --- a/cmd/cc/notification.go +++ b/cmd/cc/notification.go @@ -35,7 +35,7 @@ func init() { cmd := &cobra.Command{ Use: "subscribe", Short: "Subscribe Notification", - Long: `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`, + Long: "Access this endpoint when the user has to register for a WebSocket Session. Requires one of the following accepted registration scopes: `cjp:user` or `cloud-contact-center:pod_conv`. The `cjp-hybrid-conn:read` scope is also accepted when CCE authentication is enabled. Tokens with only admin or partner roles and no accepted registration scope are rejected.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/v1/notification/subscribe") if bodyFile != "" { diff --git a/cmd/cc/outdial_ani.go b/cmd/cc/outdial_ani.go index 3ad174c..2140e49 100644 --- a/cmd/cc/outdial_ani.go +++ b/cmd/cc/outdial_ani.go @@ -37,9 +37,9 @@ func init() { var singleObjectResponse string cmd := &cobra.Command{ Use: "list", - Short: "List Outdial ANI(s)", - Long: `Retrieve a list of Outdial ANI(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.`, + Short: "List Outdial ANIs", + Long: `Retrieve a list of Outdial ANIs in a given organization. + 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/outdial-ani") req.PathParam("orgid", orgid) @@ -70,7 +70,7 @@ func init() { 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(&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(&singleObjectResponse, "single-object-response", "", "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.") outdialAniCmd.AddCommand(cmd) } @@ -112,8 +112,8 @@ func init() { var bodyFile string cmd := &cobra.Command{ Use: "bulk-save", - Short: "Bulk save Outdial ANI(s)", - Long: `Create, Update or delete Outdial ANI(s) in bulk in a given organization.`, + Short: "Bulk save Outdial ANIs", + Long: `Create, Update or delete Outdial ANIs in bulk in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/outdial-ani/bulk") req.PathParam("orgid", orgid) @@ -172,7 +172,7 @@ func init() { outdialAniCmd.AddCommand(cmd) } - { // list-entry + { // list-entries var orgid string var filter string var attributes string @@ -180,9 +180,9 @@ func init() { var page string var pageSize string cmd := &cobra.Command{ - Use: "list-entry", - Short: "List Outdial ANI Entry(s)", - Long: `Retrieve a list of Outdial ANI Entry(s) in a given organization.`, + Use: "list-entries", + Short: "List Outdial ANI Entries", + Long: `Retrieve a list of Outdial ANI Entries in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/outdial-ani/entry") req.PathParam("orgid", orgid) @@ -410,15 +410,15 @@ func init() { outdialAniCmd.AddCommand(cmd) } - { // bulk-save-entry + { // bulk-save-entries var orgid string var outDialAniId string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "bulk-save-entry", - Short: "Bulk save Outdial ANI Entry(s)", - Long: `Create, Update or delete Outdial ANI Entry(s) in bulk for an Address Book in a given organization.`, + Use: "bulk-save-entries", + Short: "Bulk save Outdial ANI Entries", + Long: `Create, Update or delete Outdial ANI Entries in bulk for an Address Book in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/outdial-ani/{outDialAniId}/entry/bulk") req.PathParam("orgid", orgid) @@ -574,7 +574,7 @@ func init() { outdialAniCmd.AddCommand(cmd) } - { // list-entry-2 + { // list-entries-2 var orgid string var outDialAniId string var filter string @@ -583,9 +583,9 @@ func init() { var page string var pageSize string cmd := &cobra.Command{ - Use: "list-entry-2", - Short: "List Outdial ANI Entry(s)", - Long: `Retrieve a list of Outdial ANI Entry(s) in a given organization.`, + Use: "list-entries-2", + Short: "List Outdial ANI Entries", + Long: `Retrieve a list of Outdial ANI Entries in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/outdial-ani/{outDialAniId}/entry") req.PathParam("orgid", orgid) diff --git a/cmd/cc/overrides.go b/cmd/cc/overrides.go index 88b2994..ea334d8 100644 --- a/cmd/cc/overrides.go +++ b/cmd/cc/overrides.go @@ -41,7 +41,7 @@ func init() { Use: "list", Short: "List Overrides resource(s)", Long: `Retrieve a list of Overrides resource(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/overrides") req.PathParam("orgid", orgid) diff --git a/cmd/cc/realtime.go b/cmd/cc/realtime.go index 62a64db..11e13aa 100644 --- a/cmd/cc/realtime.go +++ b/cmd/cc/realtime.go @@ -35,7 +35,7 @@ func init() { cmd := &cobra.Command{ Use: "subscribe-notification", Short: "Subscribe Realtime Notification", - Long: `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`, + Long: "Access this endpoint when the user has to register for a WebSocket Session to receive realtime events. Requires one of the following accepted registration scopes: `cjp:user` or `cloud-contact-center:pod_conv`. The `cjp-hybrid-conn:read` scope is also accepted when CCE authentication is enabled. Tokens with only admin or partner roles and no accepted registration scope are rejected.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/v1/realtime/subscribe") if bodyFile != "" { diff --git a/cmd/cc/search_metadata.go b/cmd/cc/search_metadata.go new file mode 100644 index 0000000..f2e2faf --- /dev/null +++ b/cmd/cc/search_metadata.go @@ -0,0 +1,58 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package cc + +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 searchMetadataCmd = &cobra.Command{ + Use: "search-metadata", + Short: "SearchMetadata commands", +} + +func init() { + cmd.CcCmd.AddCommand(searchMetadataCmd) + + { // get + var xOrganizationId string + var trackingId string + cmd := &cobra.Command{ + Use: "get", + Short: "Get Search Metadata", + Long: "Returns schema metadata for the Webex Contact Center Search GraphQL API, describing supported queries, fields, nested structures, data types, filters, sorting options, grouping capabilities, and aggregation operations.\n\n**Authentication & Authorization:**\n- **Required Scopes:** `cjp:config` or `cjp:config_read`\n\nAn asterisk (*) in the rendered response schema indicates a required property.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/search/v2/meta") + req.Header("X-ORGANIZATION-ID", xOrganizationId) + req.Header("TrackingId", trackingId) + 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(&xOrganizationId, "x-organization-id", "", "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.") + cmd.Flags().StringVar(&trackingId, "tracking-id", "", "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ") + searchMetadataCmd.AddCommand(cmd) + } + +} diff --git a/cmd/cc/skill.go b/cmd/cc/skill.go index b1873f7..9644005 100644 --- a/cmd/cc/skill.go +++ b/cmd/cc/skill.go @@ -35,10 +35,11 @@ func init() { var page string var pageSize string var singleObjectResponse string + var include string cmd := &cobra.Command{ Use: "list", - Short: "List Skill(s)", - Long: `Retrieve a list of Skill(s) in a given organization. + Short: "List Skills", + Long: `Retrieve a list of Skills in a given organization. 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") @@ -49,6 +50,7 @@ func init() { req.QueryParam("page", page) req.QueryParam("pageSize", pageSize) req.QueryParam("singleObjectResponse", singleObjectResponse) + req.QueryParam("include", include) if config.Paginate() { resp, statusCode, err := req.DoPaginated(false) if err != nil { @@ -70,24 +72,13 @@ func init() { 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(&singleObjectResponse, "single-object-response", "", "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.") + cmd.Flags().StringVar(&include, "include", "", "Fetch array fields on demand only. Supported array fields are enumSkillValues.") skillCmd.AddCommand(cmd) } { // 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{ @@ -97,18 +88,6 @@ 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 @@ -125,18 +104,6 @@ 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) @@ -148,8 +115,8 @@ func init() { var bodyFile string cmd := &cobra.Command{ Use: "bulk-save", - Short: "Bulk save Skill(s)", - Long: `Create, Update or delete Skill(s) in bulk in a given organization.`, + Short: "Bulk save Skills", + Long: `Create, Update or delete Skills in bulk in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/skill/bulk") req.PathParam("orgid", orgid) @@ -213,8 +180,8 @@ func init() { var nextStartId string cmd := &cobra.Command{ Use: "purge-inactive", - Short: "Purge inactive Skill(s)", - Long: `Purge inactive Skill(s) older than the configured interval for a given organization.`, + Short: "Purge inactive Skills", + Long: `Purge inactive Skills older than the configured interval for a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/skill/purge-inactive-entities") req.PathParam("orgid", orgid) @@ -228,7 +195,7 @@ 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(&nextStartId, "next-start-id", "", "This is the entity ID from which items for the next purge batch with be selected.") + cmd.Flags().StringVar(&nextStartId, "next-start-id", "", "This is the entity ID from which items for the next purge batch will be selected.") skillCmd.AddCommand(cmd) } @@ -267,17 +234,6 @@ 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{ @@ -288,18 +244,6 @@ 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 @@ -318,17 +262,6 @@ 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) diff --git a/cmd/cc/tasks.go b/cmd/cc/tasks.go index cd09714..fc71664 100644 --- a/cmd/cc/tasks.go +++ b/cmd/cc/tasks.go @@ -4,7 +4,6 @@ package cc import ( "fmt" - "strconv" cmd "github.com/Cloverhound/webex-cli/cmd" "github.com/Cloverhound/webex-cli/internal/client" @@ -18,7 +17,6 @@ import ( var _ = fmt.Sprintf var _ = config.Token var _ = output.Print -var _ = strconv.Itoa var _ = timeutil.ParseLastISO var tasksCmd = &cobra.Command{ @@ -35,7 +33,7 @@ func init() { cmd := &cobra.Command{ Use: "create", Short: "Create Task", - Long: "Creates a Work Item task. Requires `CJP_User` scope for authorization.", + Long: "This feature is currently in Beta. Contact your Cisco team if you want access to this feature.\n\nCreates a new contact center task using the v2 task contract. The request body must include a `channelType` discriminator to select the task variant \u2014 `workItem` for structured form tasks, `customMessaging` for conversational messaging tasks, or `telephony` for voice tasks.\n\nOn success, returns a `201` response containing the task ID, which can be used to track the task lifecycle.\n\nRequires `cjp:task_write` OAuth scope. For partner-initiated inbound tasks (`workItem`, `customMessaging`), the `cjp:task_write` scope must be present in the partner application's access token. When an authenticated agent initiates an outdial (`telephony`) task, ensure the `cjp:task_write` scope is included in the agent's access token.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/v2/tasks") if bodyFile != "" { @@ -261,14 +259,14 @@ If the header is not present in the request or if gzip is not listed as one of t tasksCmd.AddCommand(cmd) } - { // resume + { // unhold var taskId string var mediaResourceId string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "resume", - Short: "Resume Task", + Use: "unhold", + Short: "Unhold Task", Long: `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).`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/v1/tasks/{taskId}/unhold") @@ -726,14 +724,14 @@ If the header is not present in the request or if gzip is not listed as one of t tasksCmd.AddCommand(cmd) } - { // update-2 + { // append-message 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.", + Use: "append-message", + Short: "Append Task Message", + Long: "This feature is currently in Beta. Contact your Cisco team if you want access to this feature.\n\nAppends an inbound message to an existing `workItem` or `customMessaging` task. Use this API after the initial task has been created through Create Task. Requires `cjp:task_write` OAuth scope. For partner-initiated inbound message appends, the `cjp:task_write` scope must be present in the partner application's access token.\n\nOn success, returns a `202` response containing the append event identifier as `data.id`. Partners can use this identifier to correlate subsequent webhook delivery for the appended message.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/v2/tasks/{taskId}/messages") req.PathParam("taskId", taskId) @@ -751,11 +749,78 @@ If the header is not present in the request or if gzip is not listed as one of t return output.Print(resp, statusCode) }, } - cmd.Flags().StringVar(&taskId, "task-id", "", "The unique ID of the Work Item task.") + cmd.Flags().StringVar(&taskId, "task-id", "", "UUID of the existing task to which the message will be appended.") 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) } + { // drop-participant-conference + var taskId string + var participantId string + cmd := &cobra.Command{ + Use: "drop-participant-conference", + Short: "Drop Participant From Conference", + Long: "Access this endpoint when the user needs to drop a specific participant from an active conference associated with a task. This operation removes only the targeted participant while keeping the remaining parties in the conference. Requires `cjp:user` scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis)", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/v1/tasks/{taskId}/conference/participants/{participantId}/drop") + req.PathParam("taskId", taskId) + req.PathParam("participantId", participantId) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&taskId, "task-id", "", "The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.") + cmd.MarkFlagRequired("task-id") + cmd.Flags().StringVar(&participantId, "participant-id", "", "The ID of the participant ( Agent / DN / Entry Point DN / Customer) to be dropped from the conference, maximum length 36 characters.") + cmd.MarkFlagRequired("participant-id") + tasksCmd.AddCommand(cmd) + } + + { // pause + var taskId string + cmd := &cobra.Command{ + Use: "pause", + Short: "Pause Task", + Long: "Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to pause a task that cannot be handled immediately. This API is supported only for non-real-time digital channels, such as email, social, etc. Authorization requires the `cjp:user` scope. For a list of potential response messages, refer to the [Call Control API Guide](/docs/contact-control-apis).", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/v1/tasks/{taskId}/pause") + req.PathParam("taskId", taskId) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&taskId, "task-id", "", "The unique ID represents the interaction or task that the user wants to pause.") + cmd.MarkFlagRequired("task-id") + tasksCmd.AddCommand(cmd) + } + + { // resume + var taskId string + cmd := &cobra.Command{ + Use: "resume", + Short: "Resume Task", + Long: "Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to resume a previously paused task. This API is supported only for non-real-time digital channels, such as email, social, etc. Authorization requires the `cjp:user` scope. For a list of potential response messages, refer to the [Call Control API Guide](/docs/contact-control-apis).", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/v1/tasks/{taskId}/resume") + req.PathParam("taskId", taskId) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&taskId, "task-id", "", "The unique ID represents the interaction or task that the user wants to resume.") + cmd.MarkFlagRequired("task-id") + tasksCmd.AddCommand(cmd) + } + } diff --git a/cmd/cc/team.go b/cmd/cc/team.go index 2ec9523..424c2a3 100644 --- a/cmd/cc/team.go +++ b/cmd/cc/team.go @@ -41,8 +41,8 @@ func init() { var singleObjectResponse string cmd := &cobra.Command{ Use: "list", - Short: "List Team(s)", - Long: `Retrieve a list of Team(s) in a given organization.`, + Short: "List Teams", + Long: `Retrieve a list of Teams in a given organization. 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/team") req.PathParam("orgid", orgid) @@ -70,14 +70,14 @@ 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 spaces. If they do, please enclose them in quotes to apply the filter. ") + 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 the userId field to filter teams associated with the 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", "", "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.") + cmd.Flags().StringVar(&supervisorView, "supervisor-view", "", "If set to true, the API will only return data that the user has access to, according to the User Profile.") + cmd.Flags().StringVar(&provisioningView, "provisioning-view", "", "If set to true, the API will only return data that the user has access to, according to the User Profile.") + cmd.Flags().StringVar(&singleObjectResponse, "single-object-response", "", "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.") teamCmd.AddCommand(cmd) } @@ -179,8 +179,8 @@ func init() { var bodyFile string cmd := &cobra.Command{ Use: "bulk-save", - Short: "Bulk save Team(s)", - Long: `Create, Update or delete Team(s) in bulk in a given organization.`, + Short: "Bulk save Teams", + Long: `Create, Update or delete Teams in bulk in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/team/bulk") req.PathParam("orgid", orgid) @@ -244,8 +244,8 @@ func init() { var nextStartId string cmd := &cobra.Command{ Use: "purge-inactive", - Short: "Purge inactive Team(s)", - Long: `Purge inactive Team(s) older than the configured interval for a given organization.`, + Short: "Purge inactive Teams", + Long: `Purge inactive Teams older than the configured interval for a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/team/purge-inactive-entities") req.PathParam("orgid", orgid) @@ -259,7 +259,7 @@ 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(&nextStartId, "next-start-id", "", "This is the entity ID from which items for the next purge batch with be selected.") + cmd.Flags().StringVar(&nextStartId, "next-start-id", "", "This is the entity ID from which items for the next purge batch will be selected.") teamCmd.AddCommand(cmd) } diff --git a/cmd/cc/templates.go b/cmd/cc/templates.go new file mode 100644 index 0000000..2411d8f --- /dev/null +++ b/cmd/cc/templates.go @@ -0,0 +1,148 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package cc + +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 templatesCmd = &cobra.Command{ + Use: "templates", + Short: "Templates commands", +} + +func init() { + cmd.CcCmd.AddCommand(templatesCmd) + + { // list-flow + var orgid string + var typeVal string + cmd := &cobra.Command{ + Use: "list-flow", + Short: "List Flow Templates", + Long: "List available flow templates that can be used to create new flows.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/templates") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.QueryParam("type", typeVal) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&typeVal, "type", "", "Filter by flow or subflow.") + templatesCmd.AddCommand(cmd) + } + + { // get-flow + var orgid string + var id string + cmd := &cobra.Command{ + Use: "get-flow", + Short: "Get a Flow Template", + Long: "Retrieve a specific flow template by its ID. Use this to inspect a template's flow structure before creating a flow from it.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/templates/{id}") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&id, "id", "", "Template ID.") + cmd.MarkFlagRequired("id") + templatesCmd.AddCommand(cmd) + } + + { // list-flow-2 + var typeVal string + cmd := &cobra.Command{ + Use: "list-flow-2", + Short: "List Flow Templates", + Long: "List available flow templates that can be used to create new flows.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/templates") + req.QueryParam("type", typeVal) + 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(&typeVal, "type", "", "Filter by flow or subflow.") + templatesCmd.AddCommand(cmd) + } + + { // get-flow-2 + var id string + cmd := &cobra.Command{ + Use: "get-flow-2", + Short: "Get a Flow Template", + Long: "Retrieve a specific flow template by its ID. Use this to inspect a template's flow structure before creating a flow from it.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/templates/{id}") + 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(&id, "id", "", "Template ID.") + cmd.MarkFlagRequired("id") + templatesCmd.AddCommand(cmd) + } + +} diff --git a/cmd/cc/usage_reports.go b/cmd/cc/usage_reports.go new file mode 100644 index 0000000..05eb7a1 --- /dev/null +++ b/cmd/cc/usage_reports.go @@ -0,0 +1,200 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package cc + +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 usageReportsCmd = &cobra.Command{ + Use: "usage-reports", + Short: "UsageReports commands", +} + +func init() { + cmd.CcCmd.AddCommand(usageReportsCmd) + + { // get-available-types + cmd := &cobra.Command{ + Use: "get-available-types", + Short: "Get available resource types", + Long: `Returns the list of available resource types that can be used for report generation, along with available data dates.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/v1/usage-reports/resource-types") + 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) + }, + } + usageReportsCmd.AddCommand(cmd) + } + + { // create + var resourceType string + var startDate string + var endDate string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "create", + Short: "Create usage report", + Long: "Creates a new usage report for the specified organization, resource type,\nand date range. The report is generated asynchronously in the background.\n\nA single **usage report (reportId)** is always created for each request.\nDepending on the requested date range, the report may contain **one or more\nreport files**, each representing a sub-range of the overall time period.\n\nWhen the requested date range spans **more than 30 days**, the overall range\nis **automatically split by natural calendar months**, and **multiple report\nfiles** are generated under the same report.\n\n**Examples:**\n\n- Requested range: `2025-12-23` ~ `2026-03-20`\n - Generated result:\n - Report ID: single report\n - Report files:\n - `2025-12-23` ~ `2025-12-31`\n - `2026-01-01` ~ `2026-01-31`\n - `2026-02-01` ~ `2026-02-28`\n - `2026-03-01` ~ `2026-03-20`\n\n- Requested range: `2025-12-23` ~ `2026-01-21`\n - Generated result:\n - Report ID: single report\n - Report files:\n - `2025-12-23` ~ `2026-01-21`\n\n**Important Notes:**\n- Only one usage report can be processed at a time for the same organization.\n If there is an ongoing report, new report creation requests will be rejected.\n", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/v1/usage-reports") + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("resourceType", resourceType) + req.BodyString("startDate", startDate) + req.BodyString("endDate", endDate) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&resourceType, "resource-type", "", "") + cmd.Flags().StringVar(&startDate, "start-date", "", "") + cmd.Flags().StringVar(&endDate, "end-date", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + usageReportsCmd.AddCommand(cmd) + } + + { // list + var resourceType string + var createdAfter string + var createdBefore string + cmd := &cobra.Command{ + Use: "list", + Short: "List usage reports", + Long: "Retrieves a list of usage reports for the organization. Supports optional filtering by resource type and creation date range.\n\nEach report has a `reportId` and may contain one or more generated files in `reportFiles[]`. For long date ranges, the service can split results by calendar month to avoid creating a single very large download. For example, a 12-month report can return up to 12 report files, and a 36-month report can return up to 36 report files.\n\nUse `reportId` to retrieve the overall report status, list the generated files, or delete the report. Use each file's `fileId` or `downloadUrl` to download that specific file. The download API does not accept `reportId`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/v1/usage-reports") + req.QueryParam("resourceType", resourceType) + req.QueryParam("createdAfter", createdAfter) + req.QueryParam("createdBefore", createdBefore) + 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(&resourceType, "resource-type", "", "Filter by resource type") + cmd.Flags().StringVar(&createdAfter, "created-after", "", "Filter reports created after this timestamp (ISO 8601 format)") + cmd.Flags().StringVar(&createdBefore, "created-before", "", "Filter reports created before this timestamp (ISO 8601 format)") + usageReportsCmd.AddCommand(cmd) + } + + { // get + var reportId string + cmd := &cobra.Command{ + Use: "get", + Short: "Get usage report details", + Long: `Retrieves detailed information for a specific usage report.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/v1/usage-reports/{reportId}") + req.PathParam("reportId", reportId) + 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(&reportId, "report-id", "", "Usage report ID") + cmd.MarkFlagRequired("report-id") + usageReportsCmd.AddCommand(cmd) + } + + { // delete + var reportId string + cmd := &cobra.Command{ + Use: "delete", + Short: "Delete usage report", + Long: `Deletes the specified usage report and its associated file. This operation cannot be undone.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "DELETE", "/v1/usage-reports/{reportId}") + req.PathParam("reportId", reportId) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&reportId, "report-id", "", "Usage report ID") + cmd.MarkFlagRequired("report-id") + usageReportsCmd.AddCommand(cmd) + } + + { // download-file + var fileId string + cmd := &cobra.Command{ + Use: "download-file", + Short: "Download usage report file", + Long: "Downloads one completed report file as a binary stream.\n\nUse the `fileId` returned in the report's `reportFiles` array. A `reportId` identifies the overall report and cannot be used with this endpoint. Usage Reports can cover up to 36 months of raw data, so large date ranges may be split into one file per calendar month. This keeps individual compressed files more manageable and avoids requiring customers to download a single very large file. If a report contains multiple files, call this endpoint once for each `fileId`.\n\nPassing a `reportId` to this endpoint returns `404` because the path parameter expects a file-level identifier.\n\nThe Developer Portal may not handle binary downloads reliably. Use Postman, curl, or a programmatic API client to download the file.\n\n**Note:** Both file and download URLs expire 7 days after report completion.\n", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/v1/usage-reports/{fileId}/download") + req.PathParam("fileId", fileId) + 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(&fileId, "file-id", "", "ID of the specific report file to download. Use fileId, not reportId.") + cmd.MarkFlagRequired("file-id") + usageReportsCmd.AddCommand(cmd) + } + +} diff --git a/cmd/cc/user_profiles.go b/cmd/cc/user_profiles.go index 7b298c4..d8a4c39 100644 --- a/cmd/cc/user_profiles.go +++ b/cmd/cc/user_profiles.go @@ -40,7 +40,7 @@ func init() { Use: "list", Short: "List user profiles", Long: `Retrieve a list of user profiles 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}/v3/user-profile") req.PathParam("orgid", orgid) diff --git a/cmd/cc/users.go b/cmd/cc/users.go index 51d176a..839901f 100644 --- a/cmd/cc/users.go +++ b/cmd/cc/users.go @@ -45,8 +45,8 @@ func init() { var includeDynamicSkillsLimitReached string cmd := &cobra.Command{ Use: "list", - Short: "List User(s)", - Long: `Retrieve a list of User(s) in a given organization.`, + Short: "List Users", + Long: `Retrieve a list of Users in a given organization. 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/user") req.PathParam("orgid", orgid) @@ -84,11 +84,11 @@ func init() { 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(&supervisorManagedAgentsOnly, "supervisor-managed-agents-only", "", "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.") - 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(&singleObjectResponse, "single-object-response", "", "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.") 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(&queueId, "queue-id", "", "Contact Service Queue ID for which the list of assigned or unassigned agents must be fetched.") + cmd.Flags().StringVar(&includeAimappingCount, "include-aimapping-count", "", "If set to true, the API response will include the count of each AI feature 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) } @@ -164,6 +164,7 @@ func init() { var id string var includeUserProfile string var includeNames string + var includeSkillDetails string cmd := &cobra.Command{ Use: "get-ci-id", Short: "Get specific User by CI User ID", @@ -174,6 +175,7 @@ func init() { req.PathParam("id", id) req.QueryParam("includeUserProfile", includeUserProfile) req.QueryParam("includeNames", includeNames) + req.QueryParam("includeSkillDetails", includeSkillDetails) if config.Paginate() { resp, statusCode, err := req.DoPaginated(false) if err != nil { @@ -194,6 +196,7 @@ func init() { cmd.MarkFlagRequired("id") cmd.Flags().StringVar(&includeUserProfile, "include-user-profile", "", "Specifiy whether to include user profile data") cmd.Flags().StringVar(&includeNames, "include-names", "", "Specifiy whether to include resource collection names") + cmd.Flags().StringVar(&includeSkillDetails, "include-skill-details", "", "If set to true, the response includes skill information for each dynamic skill assignment.") usersCmd.AddCommand(cmd) } @@ -202,18 +205,6 @@ 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{ @@ -232,19 +223,6 @@ 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 { @@ -258,24 +236,12 @@ 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-ids + { // list-2 var orgid string var page string var pageSize string @@ -285,8 +251,8 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "get-ids", - Short: "Fetch User details by IDs", + Use: "list-2", + Short: "List Users with details", 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") @@ -328,7 +294,7 @@ func init() { cmd := &cobra.Command{ Use: "list-along-profile", Short: "List Users along with profile", - Long: `Retrieve a list of User(s) along with their UserProfiles in a given organization.`, + Long: `Retrieve a list of Users along with their User Profiles in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/user/with-user-profile") req.PathParam("orgid", orgid) @@ -357,7 +323,7 @@ func init() { cmd := &cobra.Command{ Use: "get-along-profile-id", Short: "Get specific User along with profile by ID", - Long: `Retrieve an existing User along with the corresponding UserProfile by ID in a given organization.`, + Long: `Retrieve an existing User along with the corresponding User Profile by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/user/with-user-profile/{id}") req.PathParam("orgid", orgid) @@ -391,6 +357,8 @@ func init() { var includeSkillProfileAudit string var includeReskillAuditInfo string var includeSkillDetails string + var checkIfUserHasDynamicSkill string + var dynamicSkillId string cmd := &cobra.Command{ Use: "get-id", Short: "Get specific User by ID", @@ -404,6 +372,8 @@ func init() { req.QueryParam("includeSkillProfileAudit", includeSkillProfileAudit) req.QueryParam("includeReskillAuditInfo", includeReskillAuditInfo) req.QueryParam("includeSkillDetails", includeSkillDetails) + req.QueryParam("checkIfUserHasDynamicSkill", checkIfUserHasDynamicSkill) + req.QueryParam("dynamicSkillId", dynamicSkillId) if config.Paginate() { resp, statusCode, err := req.DoPaginated(false) if err != nil { @@ -422,11 +392,13 @@ 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 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(&includeCount, "include-count", "", "If set to true, the API response will include the count of each type of Contact Service Queue to which the user is assigned.") + cmd.Flags().StringVar(&includeUserProfileType, "include-user-profile-type", "", "If set to true, the API response includes 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") + cmd.Flags().StringVar(&includeSkillDetails, "include-skill-details", "", "If set to true, the response includes skill information for each dynamic skill assignment.") + cmd.Flags().StringVar(&checkIfUserHasDynamicSkill, "check-if-user-has-dynamic-skill", "", "If set to true, checks if user has the specified dynamic skill") + cmd.Flags().StringVar(&dynamicSkillId, "dynamic-skill-id", "", "Dynamic skill ID to check if user has it assigned (required when checkIfUserHasDynamicSkill is true)") usersCmd.AddCommand(cmd) } @@ -547,14 +519,14 @@ func init() { usersCmd.AddCommand(cmd) } - { // bulk-update-dynamic-skills + { // bulk-partial-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", + Use: "bulk-partial-update-dynamic-skills", + Short: "Bulk partial update Users with 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}") @@ -576,7 +548,7 @@ 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(&skillId, "skill-id", "", "The unique identifier of the skill.") + cmd.Flags().StringVar(&skillId, "skill-id", "", "Dynamic skill ID used for bulk update") cmd.MarkFlagRequired("skill-id") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") @@ -660,4 +632,42 @@ func init() { usersCmd.AddCommand(cmd) } + { // list-call-monitoring-id + var orgid string + var id string + var page string + var pageSize string + cmd := &cobra.Command{ + Use: "list-call-monitoring-id", + Short: "List users by call monitoring id", + Long: `Fetch paginated users associated to the selected call monitoring team filters while enforcing team ACL.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/user/by-call-monitoring-id/{id}") + req.PathParam("orgid", orgid) + req.PathParam("id", id) + 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(&id, "id", "", "Resource ID of the call monitoring.") + cmd.MarkFlagRequired("id") + 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) + } + } diff --git a/cmd/device/device_call.go b/cmd/device/device_call.go index 26916af..ba57822 100644 --- a/cmd/device/device_call.go +++ b/cmd/device/device_call.go @@ -1072,7 +1072,7 @@ func init() { cmd := &cobra.Command{ Use: "get-layout-id", Short: "Get Device Layout by Device ID", - Long: "Get layout information of a device by device ID in an organization.\n\nDevice layout customizes a user\u2019s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user\u2019s monitoring list.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", + Long: "Get layout information of a device by device ID in an organization.\n\nDevice layout customizes a user\u2019s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user\u2019s monitoring list.\n\n**Note:** When `layoutMode` is DEFAULT, the response includes only `layoutMode` and `userReorderEnabled`. The `lineKeys` field is omitted as the device uses system-assigned default line-key assignments. When `layoutMode` is CUSTOM, the response includes the `lineKeys` array with the custom line-key configuration.\n\nThis API requires a full 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/devices/{deviceId}/layout") req.PathParam("deviceId", deviceId) @@ -1105,7 +1105,7 @@ func init() { cmd := &cobra.Command{ Use: "update-layout-id", Short: "Modify Device Layout by Device ID", - Long: "Modify the layout of a device by device ID in an organization.\n\nDevice layout customizes a user\u2019s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user\u2019s monitoring list.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", + Long: "Modify the layout of a device by device ID in an organization.\n\nDevice layout customizes a user\u2019s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user\u2019s monitoring list.\n\n**Note:** When setting `layoutMode` to DEFAULT, do not include the `lineKeys` field in the request body. The device will use system-assigned default line-key assignments. When setting `layoutMode` to CUSTOM, you must include the `lineKeys` array to specify the custom line-key configuration.\n\nThis API 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, "PUT", "/telephony/config/devices/{deviceId}/layout") req.PathParam("deviceId", deviceId) diff --git a/cmd/meetings/meetings.go b/cmd/meetings/meetings.go index 956351e..e82b48c 100644 --- a/cmd/meetings/meetings.go +++ b/cmd/meetings/meetings.go @@ -284,7 +284,7 @@ func init() { cmd := &cobra.Command{ Use: "patch", Short: "Patch a Meeting", - Long: "Updates details for a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be updated.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation updates that scheduled meeting without impact on other scheduled meeting of the parent meeting series.\n\n* If the `meetingId` value specified is for a meeting series, the operation updates the entire meeting series. **Note**: If the value of `start`, `end`, or `recurrence` for the meeting series is changed, any exceptional scheduled meeting in this series is cancelled when the meeting series is updated.\n\n* The `agenda`, `recurrence`, and `trackingCodes` attributes can be specified as `null` so that these attributes become null and hidden from the response after the patch. Note that it's the keyword `null` not the string \"null\".\n\n* If the parameter `recurrence` has a value, a recurring meeting is created based on the rule defined by the value of `recurrence`. For a non-recurring meeting which has no `recurrence` value set, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling. If you specify a `recurrence` like `FREQ=DAILY;INTERVAL=1` which never ends, the furthest date of the series is unlimited. You can also specify a `recurrence` with a very distant ending date in the future, e.g. `FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z`, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting.\n\n* You can't update a meeting that starts 10 years or more in the future.\n\n* Updating a meeting in the API that was created via a calendar connector is not allowed. The meeting may be updated in Webex, but the calendar event may not be updated, resulting in duplicate entries. This action is therefore blocked. In case you must overwrite this behavior, please contact devsupport@webex.com.", + Long: "
\nIf only guests are waiting in the lobby and the host or cohost has not started the meeting, the meeting state remains `inProgress` for 5 minutes after the last guest leaves. The meeting cannot be patched during this time. If the meeting is started by the host or cohost and then ended normally, it can be patched immediately after it ends.\n
\n\nUpdates details for a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be updated.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation updates that scheduled meeting without impact on other scheduled meeting of the parent meeting series.\n\n* If the `meetingId` value specified is for a meeting series, the operation updates the entire meeting series. **Note**: If the value of `start`, `end`, or `recurrence` for the meeting series is changed, any exceptional scheduled meeting in this series is cancelled when the meeting series is updated.\n\n* The `agenda`, `recurrence`, and `trackingCodes` attributes can be specified as `null` so that these attributes become null and hidden from the response after the patch. Note that it's the keyword `null` not the string \"null\".\n\n* If the parameter `recurrence` has a value, a recurring meeting is created based on the rule defined by the value of `recurrence`. For a non-recurring meeting which has no `recurrence` value set, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling. If you specify a `recurrence` like `FREQ=DAILY;INTERVAL=1` which never ends, the furthest date of the series is unlimited. You can also specify a `recurrence` with a very distant ending date in the future, e.g. `FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z`, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting.\n\n* You can't update a meeting that starts 10 years or more in the future.\n\n* Updating a meeting in the API that was created via a calendar connector is not allowed. The meeting may be updated in Webex, but the calendar event may not be updated, resulting in duplicate entries. This action is therefore blocked. In case you must overwrite this behavior, please contact devsupport@webex.com.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PATCH", "/meetings/{meetingId}") req.PathParam("meetingId", meetingId) @@ -316,7 +316,7 @@ func init() { cmd := &cobra.Command{ Use: "update", Short: "Update a Meeting", - Long: "
\nThe PUT method is still supported and behaves the same as before, will be deprecated in the future. Use the PATCH method instead.\n
\n\nUpdates details for a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be updated.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation updates that scheduled meeting without impact on other scheduled meeting of the parent meeting series.\n\n* If the `meetingId` value specified is for a meeting series, the operation updates the entire meeting series. **Note**: If the value of `start`, `end`, or `recurrence` for the meeting series is changed, any exceptional scheduled meeting in this series is cancelled when the meeting series is updated.\n\n* If the parameter `recurrence` has a value, a recurring meeting is created based on the rule defined by the value of `recurrence`. For a non-recurring meeting which has no `recurrence` value set, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling. If you specify a `recurrence` like `FREQ=DAILY;INTERVAL=1` which never ends, the furthest date of the series is unlimited. You can also specify a `recurrence` with a very distant ending date in the future, e.g. `FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z`, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting.\n\n* You can't update a meeting that starts 10 years or more in the future.\n\n* Updating a meeting created using the API via a calendar connector is not supported. While the meeting may be updated in Webex, the calendar event may not be updated resulting in duplicate entries. If you need to override this behavior, contact devsupport@webex.com.", + Long: "
\nThe PUT method is still supported and behaves the same as before, will be deprecated in the future. Use the PATCH method instead.\n
\n\n
\nIf only guests are waiting in the lobby and the host or cohost has not started the meeting, the meeting state remains `inProgress` for 5 minutes after the last guest leaves. The meeting cannot be updated during this time. If the meeting is started by the host or cohost and then ended normally, it can be updated immediately after it ends.\n
\n\nUpdates details for a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be updated.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation updates that scheduled meeting without impact on other scheduled meeting of the parent meeting series.\n\n* If the `meetingId` value specified is for a meeting series, the operation updates the entire meeting series. **Note**: If the value of `start`, `end`, or `recurrence` for the meeting series is changed, any exceptional scheduled meeting in this series is cancelled when the meeting series is updated.\n\n* If the parameter `recurrence` has a value, a recurring meeting is created based on the rule defined by the value of `recurrence`. For a non-recurring meeting which has no `recurrence` value set, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling. If you specify a `recurrence` like `FREQ=DAILY;INTERVAL=1` which never ends, the furthest date of the series is unlimited. You can also specify a `recurrence` with a very distant ending date in the future, e.g. `FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z`, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting.\n\n* You can't update a meeting that starts 10 years or more in the future.\n\n* Updating a meeting created using the API via a calendar connector is not supported. While the meeting may be updated in Webex, the calendar event may not be updated resulting in duplicate entries. If you need to override this behavior, contact devsupport@webex.com.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/meetings/{meetingId}") req.PathParam("meetingId", meetingId) @@ -348,7 +348,7 @@ func init() { cmd := &cobra.Command{ Use: "delete", Short: "Delete a Meeting", - Long: "Deletes a meeting with a specified meeting ID. The deleted meeting cannot be recovered. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be deleted.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation deletes that scheduled meeting without impact on other scheduled meeting of the parent meeting series.\n\n* If the `meetingId` value specified is for a meeting series, the operation deletes the entire meeting series.", + Long: "
\nIf only guests are waiting in the lobby and the host or cohost has not started the meeting, the meeting state remains `inProgress` for 5 minutes after the last guest leaves. The meeting cannot be deleted during this time. If the meeting is started by the host or cohost and then ended normally, it can be deleted immediately after it ends.\n
\n\nDeletes a meeting with a specified meeting ID. The deleted meeting cannot be recovered. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be deleted.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation deletes that scheduled meeting without impact on other scheduled meeting of the parent meeting series.\n\n* If the `meetingId` value specified is for a meeting series, the operation deletes the entire meeting series.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "DELETE", "/meetings/{meetingId}") req.PathParam("meetingId", meetingId) @@ -1790,4 +1790,125 @@ func init() { meetingsCmd.AddCommand(cmd) } + { // list-group + var personId string + var meetingNumber string + var webLink string + var current string + var timezone string + var hostEmail string + cmd := &cobra.Command{ + Use: "list-group", + Short: "List Group Meetings", + Long: "List group meetings with a specified meeting number or web link by a service app which has group meeting access. You can specify the `personId` parameter or `hostEmail` header of whom the meetings will be retrieved. Please note that there are various products in the [Webex Suite](https://www.webex.com/collaboration-suite.html) such as `Meetings` and `Events`. Currently, only meetings of the `Meetings` product are supported by this API, meetings of others in the suite are not supported. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` will not be listed.\n\n* One of the `personId` parameter and `hostEmail` header must be specified so that only meetings hosted by the person of `personId` or `hostEmail` will be listed.\n\n* `meetingNumber` and `webLink` are mutually exclusive and they cannot be specified simultaneously, but one of them must be specified. The operation returns an array of meeting objects specified by the `meetingNumber` or `webLink`.\n\n* Each object in the array can be a scheduled meeting or a meeting series depending on whether the `current` parameter is `true` or `false`. If it's `false`, the `start` and `end` attributes are for the first scheduled meeting of that series. If it's `true` or not specified, the `start` and `end` attributes are for the scheduled meeting which is ready to start or join or the upcoming scheduled meeting of that series.\n\n* To learn more about which attributes are available for different meeting states, please refer to [Available Meeting Attributes for Different Meeting States](/docs/meetings#available-meeting-attributes-for-different-meeting-states).\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.\n\n* `hostEmail`: Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/group/meetings") + req.QueryParam("personId", personId) + req.QueryParam("meetingNumber", meetingNumber) + req.QueryParam("webLink", webLink) + req.QueryParam("current", current) + req.Header("timezone", timezone) + req.Header("hostEmail", hostEmail) + 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", "", "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.") + cmd.Flags().StringVar(&meetingNumber, "meeting-number", "", "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.") + cmd.Flags().StringVar(&webLink, "web-link", "", "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.") + cmd.Flags().StringVar(¤t, "current", "", "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.") + cmd.Flags().StringVar(&timezone, "timezone", "", "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.") + cmd.Flags().StringVar(&hostEmail, "host-email", "", "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.") + meetingsCmd.AddCommand(cmd) + } + + { // patch-group + var meetingId string + var personId string + var hostEmail string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "patch-group", + Short: "Patch a Group Meeting", + Long: "Patches details for a group meeting with a specified meeting ID by a service app which has group meeting access. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be updated.\n\n* One of the `personId` parameter and `hostEmail` header must be specified so that only meetings hosted by the person of `personId` or `hostEmail` will be patch.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation updates that scheduled meeting without impact on other scheduled meeting of the parent meeting series.\n\n* If the `meetingId` value specified is for a meeting series, the operation updates the entire meeting series. **Note**: If the value of `start`, `end`, or `recurrence` for the meeting series is changed, any exceptional scheduled meeting in this series is cancelled when the meeting series is updated.\n\n* The `agenda`, `recurrence`, and `trackingCodes` attributes can be specified as `null` so that these attributes become null and hidden from the response after the patch. Note that it's the keyword `null` not the string \"null\".\n\n* If the parameter `recurrence` has a value, a recurring meeting is created based on the rule defined by the value of `recurrence`. For a non-recurring meeting which has no `recurrence` value set, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling. If you specify a `recurrence` like `FREQ=DAILY;INTERVAL=1` which never ends, the furthest date of the series is unlimited. You can also specify a `recurrence` with a very distant ending date in the future, e.g. `FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z`, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting.\n\n* You can't update a meeting that starts 10 years or more in the future.\n\n* Updating a meeting in the API that was created via a calendar connector is not allowed. The meeting may be updated in Webex, but the calendar event may not be updated, resulting in duplicate entries. This action is therefore blocked. In case you must overwrite this behavior, please contact devsupport@webex.com.\n\n#### Request Header\n\n* `hostEmail`: Email of the user whose meeting will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "PATCH", "/group/meetings/{meetingId}") + req.PathParam("meetingId", meetingId) + req.QueryParam("personId", personId) + req.Header("hostEmail", hostEmail) + 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(&meetingId, "meeting-id", "", "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.") + cmd.MarkFlagRequired("meeting-id") + cmd.Flags().StringVar(&personId, "person-id", "", "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.") + cmd.Flags().StringVar(&hostEmail, "host-email", "", "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + meetingsCmd.AddCommand(cmd) + } + + { // update-group-control-status + var personId string + var hostEmail string + var meetingId string + var action string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update-group-control-status", + Short: "Update Group Meeting Control Status", + Long: "Update meeting recording control status by a service app which has group meeting access. The service app can use this API to start, stop, pause, or resume meeting recording by providing an `action` value. The `personId` parameter or `hostEmail` header of the person to whom the meeting belongs must be specified. The service app which invokes the API manages one or more groups, and it also manages one or more sites. The user specified by `hostEmail` or `personId` must be in a group that is managed by the service app. The meeting specified by `meetingId` must be on a site that is managed by the service app. Please note that once the meeting recording has been controlled by a person in the meeting, the recording control of this meeting can no longer be controlled by the service app via the API.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "POST", "/group/meetings/controls") + req.QueryParam("personId", personId) + req.Header("hostEmail", hostEmail) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("meetingId", meetingId) + req.BodyString("action", action) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&personId, "person-id", "", "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.") + cmd.Flags().StringVar(&hostEmail, "host-email", "", "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.") + cmd.Flags().StringVar(&meetingId, "meeting-id", "", "") + cmd.Flags().StringVar(&action, "action", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + meetingsCmd.AddCommand(cmd) + } + } diff --git a/cmd/meetings/people.go b/cmd/meetings/people.go index f5c40d5..33bc5be 100644 --- a/cmd/meetings/people.go +++ b/cmd/meetings/people.go @@ -153,7 +153,7 @@ func init() { cmd := &cobra.Command{ Use: "update-person", Short: "Update a Person", - Long: "Update details for a person, by ID.\n\nSpecify the person ID in the `personId` parameter in the URI. Only an admin can update a person details.\n\nInclude all details for the person. This action expects all user details to be present in the request. A common approach is to first [GET the person's details](/docs/api/v1/people/get-person-details), make changes, then PUT both the changed and unchanged values.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.\n\nWhen doing attendee management, to update a user from host role to an attendee for a site append `#attendee` to the respective `siteUrl` and remove the meeting host license for this site from the license array.\nTo update a person from an attendee role to a host for a site, add the meeting license for this site in the meeting array, and remove that site from the `siteurl` parameter.\n\nTo remove the attendee privilege for a user on a meeting site, remove the `sitename#attendee` from the `siteUrl`s array. The `showAllTypes` parameter must be set to `true`.\n\n**NOTE**:\n\n* The `locationId` can only be set when assigning a calling license to a user. It cannot be changed if a user is already an existing calling user.\n\n* The `extension` field should be used to update the Webex Calling extension for a person. The extension value should not include the location routing prefix. The `work_extension` type in the `phoneNumbers` object as seen in the response payload of [List People](/docs/api/v1/people/list-people) or [Get Person Details](/docs/api/v1/people/get-person-details), cannot be used to set the Webex Calling extension for a person.\n\n* When updating a user with multiple email addresses using a PUT request, ensure that the primary email address is listed first in the array. Note that the order of email addresses returned by a GET request is not guaranteed..\n\n* The People API is a combination of several microservices, each responsible for specific attributes of a person. As a result, a PUT request that returns an error response code may still have altered some values of the person's data. Therefore, it is recommended to perform a GET request after encountering an error to verify the current state of the resource. \n\n* Some licenses are implicitly assigned by the system and cannot be admin controlled. They are necessary for the baseline function of the Webex system. If you get an error about implicitly assigned licensed that cannot be removed, please ensure you have the corresponding license in your PUT request.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.", + Long: "Update details for a person, by ID.\n\nSpecify the person ID in the `personId` parameter in the URI. Only an admin can update a person details.\n\nInclude all details for the person. This action expects all user details to be present in the request. A common approach is to first [GET the person's details](/docs/api/v1/people/get-person-details), make changes, then PUT both the changed and unchanged values.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.\n\nWhen doing attendee management, to update a user from host role to an attendee for a site append `#attendee` to the respective `siteUrl` and remove the meeting host license for this site from the license array.\nTo update a person from an attendee role to a host for a site, add the meeting license for this site in the meeting array, and remove that site from the `siteurl` parameter.\n\nTo remove the attendee privilege for a user on a meeting site, remove the `sitename#attendee` from the `siteUrl`s array. The `showAllTypes` parameter must be set to `true`.\n\n**NOTE**:\n\n* When assigning a Webex Calling license, either a telephone number or extension must already be assigned to the person or provided in the request payload.\n\n* When `callingData` is set to `true`, a Webex Calling license must be included in the `licenses` array.\n\n* The `locationId` can only be set when assigning a calling license to a user. It cannot be changed if a user is already an existing calling user.\n\n* The `extension` field should be used to update the Webex Calling extension for a person. The extension value should not include the location routing prefix. The `work_extension` type in the `phoneNumbers` object as seen in the response payload of [List People](/docs/api/v1/people/list-people) or [Get Person Details](/docs/api/v1/people/get-person-details), cannot be used to set the Webex Calling extension for a person.\n\n* When updating a user with multiple email addresses using a PUT request, ensure that the primary email address is listed first in the array. Note that the order of email addresses returned by a GET request is not guaranteed..\n\n* The People API is a combination of several microservices, each responsible for specific attributes of a person. As a result, a PUT request that returns an error response code may still have altered some values of the person's data. Therefore, it is recommended to perform a GET request after encountering an error to verify the current state of the resource. \n\n* Some licenses are implicitly assigned by the system and cannot be admin controlled. They are necessary for the baseline function of the Webex system. If you get an error about implicitly assigned licensed that cannot be removed, please ensure you have the corresponding license in your PUT request.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/people/{personId}") req.PathParam("personId", personId) diff --git a/cmd/meetings/recordings.go b/cmd/meetings/recordings.go index 155827e..9b8cff6 100644 --- a/cmd/meetings/recordings.go +++ b/cmd/meetings/recordings.go @@ -4,6 +4,7 @@ package meetings import ( "fmt" + "strconv" "strings" cmd "github.com/Cloverhound/webex-cli/cmd" @@ -18,6 +19,7 @@ import ( var _ = fmt.Sprintf var _ = config.Token var _ = output.Print +var _ = strconv.Itoa var _ = strings.Join var _ = timeutil.ParseLastISO @@ -46,7 +48,7 @@ func init() { cmd := &cobra.Command{ Use: "list", Short: "List Recordings", - Long: "Lists recordings. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nOnly recordings of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. **NOTE**: when `meetingId` is specified, parameter of `siteUrl` will be ignored.\n\n* If `siteUrl` is specified, recordings of the specified site will be listed; otherwise, the API lists recordings of all the user's sites. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + Long: "
This API is still supported and behaves the same as before, but will be deprecated in the future. Due to limited support for special characters when filtering recordings by `topic`, it is recommended to use the new [Query Recordings](/docs/api/v1/recordings/query-recordings) API instead.
\n\nLists recordings. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nOnly recordings of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. **NOTE**: when `meetingId` is specified, parameter of `siteUrl` will be ignored.\n\n* If `siteUrl` is specified, recordings of the specified site will be listed; otherwise, the API lists recordings of all the user's sites. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/recordings") if last != "" { @@ -114,7 +116,7 @@ func init() { cmd := &cobra.Command{ Use: "list-admin-compliance-officer", Short: "List Recordings For an Admin or Compliance Officer", - Long: "List recordings for an admin or compliance officer. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. Please note that when `meetingId` is specified, parameters of `siteUrl`, `from`, and `to` will be ignored.\n\n* If `siteUrl` is specified, all the recordings on the specified site are listed; otherwise, all the recordings on the admin user's or compliance officer's preferred site are listed. All the available Webex sites and the admin user's or compliance officer's preferred site can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + Long: "
This API is still supported and behaves the same as before, but will be deprecated in the future. Due to limited support for special characters when filtering recordings by `topic`, it is recommended to use the new [Query Recordings For an Admin or Compliance Officer](/docs/api/v1/recordings/query-recordings-for-an-admin-or-compliance-officer) API instead.
\n\nList recordings for an admin or compliance officer. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. Please note that when `meetingId` is specified, parameters of `siteUrl`, `from`, and `to` will be ignored.\n\n* If `siteUrl` is specified, all the recordings on the specified site are listed; otherwise, all the recordings on the admin user's or compliance officer's preferred site are listed. All the available Webex sites and the admin user's or compliance officer's preferred site can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/admin/recordings") if last != "" { @@ -436,7 +438,6 @@ func init() { var to string var siteUrl string var integrationTag string - var topic string var format string var serviceType string var timezone string @@ -461,7 +462,6 @@ func init() { req.QueryParam("to", to) req.QueryParam("siteUrl", siteUrl) req.QueryParam("integrationTag", integrationTag) - req.QueryParam("topic", topic) req.QueryParam("format", format) req.QueryParam("serviceType", serviceType) req.Header("timezone", timezone) @@ -486,7 +486,6 @@ func init() { cmd.Flags().StringVar(&to, "to", "", "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.") cmd.Flags().StringVar(&siteUrl, "site-url", "", "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.") cmd.Flags().StringVar(&integrationTag, "integration-tag", "", "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".") - cmd.Flags().StringVar(&topic, "topic", "", "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.") cmd.Flags().StringVar(&format, "format", "", "Recording's file format. If specified, the API filters recordings by format.") cmd.Flags().StringVar(&serviceType, "service-type", "", "The service type for recordings. If specified, the API filters recordings by service type.") cmd.Flags().StringVar(&timezone, "timezone", "", "e.g. UTC") @@ -576,4 +575,132 @@ func init() { recordingsCmd.AddCommand(cmd) } + { // query + var timezone string + var max int64 + var from string + var to string + var meetingId string + var siteUrl string + var integrationTag string + var hostEmail string + var topic string + var format string + var serviceType string + var status string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "query", + Short: "Query Recordings", + Long: "Queries recordings with filters in the request body. You can specify a date range, a parent meeting ID, the maximum number of recordings to return, and additional filters such as siteUrl, integrationTag, hostEmail, topic, format, serviceType, and status.\n\nOnly recordings of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. **NOTE**: when `meetingId` is specified, parameter of `siteUrl` will be ignored.\n\n* If `siteUrl` is specified, recordings of the specified site will be listed; otherwise, the API lists recordings of all the user's sites. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "POST", "/recordings/query") + req.Header("timezone", timezone) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyInt("max", max, cmd.Flags().Changed("max")) + req.BodyString("from", from) + req.BodyString("to", to) + req.BodyString("meetingId", meetingId) + req.BodyString("siteUrl", siteUrl) + req.BodyString("integrationTag", integrationTag) + req.BodyString("hostEmail", hostEmail) + req.BodyString("topic", topic) + req.BodyString("format", format) + req.BodyString("serviceType", serviceType) + req.BodyString("status", status) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&timezone, "timezone", "", "e.g. UTC") + cmd.Flags().Int64Var(&max, "max", 0, "") + cmd.Flags().StringVar(&from, "from", "", "") + cmd.Flags().StringVar(&to, "to", "", "") + cmd.Flags().StringVar(&meetingId, "meeting-id", "", "") + cmd.Flags().StringVar(&siteUrl, "site-url", "", "") + cmd.Flags().StringVar(&integrationTag, "integration-tag", "", "") + cmd.Flags().StringVar(&hostEmail, "host-email", "", "") + cmd.Flags().StringVar(&topic, "topic", "", "") + cmd.Flags().StringVar(&format, "format", "", "") + cmd.Flags().StringVar(&serviceType, "service-type", "", "") + cmd.Flags().StringVar(&status, "status", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + recordingsCmd.AddCommand(cmd) + } + + { // query-admin-compliance-officer + var timezone string + var max int64 + var from string + var to string + var meetingId string + var siteUrl string + var integrationTag string + var topic string + var format string + var serviceType string + var status string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "query-admin-compliance-officer", + Short: "Query Recordings For an Admin or Compliance Officer", + Long: "Queries recordings for an admin or compliance officer with filters in the request body. You can specify a date range, a parent meeting ID, the maximum number of recordings to return, and additional filters such as siteUrl, integrationTag, topic, format, serviceType, and status.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. Please note that when `meetingId` is specified, parameters of `siteUrl`, `from`, and `to` will be ignored.\n\n* If `siteUrl` is specified, all the recordings on the specified site are listed; otherwise, all the recordings on the admin user's or compliance officer's preferred site are listed. All the available Webex sites and the admin user's or compliance officer's preferred site can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "POST", "/admin/recordings/query") + req.Header("timezone", timezone) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyInt("max", max, cmd.Flags().Changed("max")) + req.BodyString("from", from) + req.BodyString("to", to) + req.BodyString("meetingId", meetingId) + req.BodyString("siteUrl", siteUrl) + req.BodyString("integrationTag", integrationTag) + req.BodyString("topic", topic) + req.BodyString("format", format) + req.BodyString("serviceType", serviceType) + req.BodyString("status", status) + req.BodyString("timezone", timezone) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&timezone, "timezone", "", "e.g. UTC") + cmd.Flags().Int64Var(&max, "max", 0, "") + cmd.Flags().StringVar(&from, "from", "", "") + cmd.Flags().StringVar(&to, "to", "", "") + cmd.Flags().StringVar(&meetingId, "meeting-id", "", "") + cmd.Flags().StringVar(&siteUrl, "site-url", "", "") + cmd.Flags().StringVar(&integrationTag, "integration-tag", "", "") + cmd.Flags().StringVar(&topic, "topic", "", "") + cmd.Flags().StringVar(&format, "format", "", "") + cmd.Flags().StringVar(&serviceType, "service-type", "", "") + cmd.Flags().StringVar(&status, "status", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + recordingsCmd.AddCommand(cmd) + } + } diff --git a/cmd/messaging/hds.go b/cmd/messaging/hds.go index e7bb172..d9d998b 100644 --- a/cmd/messaging/hds.go +++ b/cmd/messaging/hds.go @@ -94,7 +94,7 @@ To obtain the Cluster ID needed for this API, use the [Get organization details cmd := &cobra.Command{ Use: "get-org", Short: "Get organization details", - Long: `Retrieve details for an HDS organization, such as the organization name, type of organization, and clusters in the organization. + Long: `Retrieve details for an HDS organization, such as the organization name, type of organization. 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}") @@ -307,4 +307,150 @@ To obtain the Organization ID needed for this API, use the [Organizations API](< hdsCmd.AddCommand(cmd) } + { // list-nodes-cluster + var clusterId string + cmd := &cobra.Command{ + Use: "list-nodes-cluster", + Short: "List nodes for an HDS cluster", + Long: `Retrieve a list of all nodes for a specific HDS cluster, including availability, proxy details, deployment type, and release version. +To obtain the Cluster ID needed for this API, use the [List clusters for an HDS organization API]()`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/clusters/{clusterId}/nodes") + req.PathParam("clusterId", clusterId) + 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(&clusterId, "cluster-id", "", "Unique ID of the HDS cluster.") + cmd.MarkFlagRequired("cluster-id") + hdsCmd.AddCommand(cmd) + } + + { // list-clusters-org + var organizationId string + cmd := &cobra.Command{ + Use: "list-clusters-org", + Short: "List clusters for an HDS organization", + Long: `Retrieve a list of all clusters for a specific HDS organization, including cluster status, release channel, and upgrade schedule details. +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}/clusters") + 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-alarms-node + var nodeId string + var from string + var to string + var last string + cmd := &cobra.Command{ + Use: "get-alarms-node", + Short: "Get alarms for an HDS node", + Long: `Returns the alarm details for a single HDS node for the provided time range (last 24 hours). +To obtain the Node ID needed for this API, use the [List nodes for an HDS cluster API]()`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/nodes/{nodeId}/alarms") + if last != "" { + var err error + from, to, err = timeutil.ParseLastISO(last) + if err != nil { + return err + } + } + req.PathParam("nodeId", nodeId) + req.QueryParam("from", from) + req.QueryParam("to", to) + 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(&nodeId, "node-id", "", "Unique ID of the HDS node.") + cmd.MarkFlagRequired("node-id") + cmd.Flags().StringVar(&from, "from", "", "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.") + cmd.Flags().StringVar(&to, "to", "", "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.") + cmd.Flags().StringVar(&last, "last", "", "Time range shorthand (e.g. 1h, 30m, 24h). Sets --from automatically.") + hdsCmd.AddCommand(cmd) + } + + { // get-usage-node + var nodeId string + var from string + var to string + var last string + cmd := &cobra.Command{ + Use: "get-usage-node", + Short: "Get resource usage for an HDS node", + Long: `Retrieve CPU, memory, and disk resource usage details for a specific HDS node over the requested time range. +To obtain the Node ID needed for this API, use the [List nodes for an HDS cluster API]()`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/nodes/{nodeId}/resourceUsage") + if last != "" { + var err error + from, to, err = timeutil.ParseLastISO(last) + if err != nil { + return err + } + } + req.PathParam("nodeId", nodeId) + req.QueryParam("from", from) + req.QueryParam("to", to) + 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(&nodeId, "node-id", "", "Unique ID of the HDS node.") + cmd.MarkFlagRequired("node-id") + cmd.Flags().StringVar(&from, "from", "", "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.") + cmd.Flags().StringVar(&to, "to", "", "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.") + cmd.Flags().StringVar(&last, "last", "", "Time range shorthand (e.g. 1h, 30m, 24h). Sets --from automatically.") + hdsCmd.AddCommand(cmd) + } + } diff --git a/cmd/messaging/hybrid_data_security.go b/cmd/messaging/hybrid_data_security.go new file mode 100644 index 0000000..675d3ab --- /dev/null +++ b/cmd/messaging/hybrid_data_security.go @@ -0,0 +1,398 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package messaging + +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/Cloverhound/webex-cli/internal/timeutil" + "github.com/spf13/cobra" +) + +// Ensure imports are used. +var _ = fmt.Sprintf +var _ = config.Token +var _ = output.Print +var _ = timeutil.ParseLastISO + +var hybridDataSecurityCmd = &cobra.Command{ + Use: "hybrid-data-security", + Short: "HybridDataSecurity commands", +} + +func init() { + cmd.MessagingCmd.AddCommand(hybridDataSecurityCmd) + + { // get-org + var organizationId string + cmd := &cobra.Command{ + Use: "get-org", + Short: "Get organization details", + Long: `Retrieve details for an Hybrid Data Security organization, such as the organization name, type of organization. +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}") + 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 Hybrid Data Security organization.") + cmd.MarkFlagRequired("organization-id") + hybridDataSecurityCmd.AddCommand(cmd) + } + + { // list-clusters-org + var organizationId string + cmd := &cobra.Command{ + Use: "list-clusters-org", + Short: "List clusters for an Hybrid Data Security organization", + Long: `Retrieve a list of all clusters for a specific Hybrid Data Security organization, including cluster status, release channel, and upgrade schedule details. +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}/clusters") + 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 Hybrid Data Security organization.") + cmd.MarkFlagRequired("organization-id") + hybridDataSecurityCmd.AddCommand(cmd) + } + + { // get-cluster + var clusterId string + cmd := &cobra.Command{ + Use: "get-cluster", + Short: "Get cluster details", + Long: `Retrieve details for a specific Hybrid Data Security cluster, such as the cluster name, cluster status, upgrade schedule, and Hybrid Data Security nodes in the cluster. +To obtain the Cluster ID needed for this API, use the [Get organization details API]()`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/clusters/{clusterId}") + req.PathParam("clusterId", clusterId) + 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(&clusterId, "cluster-id", "", "Unique ID of the Hybrid Data Security cluster.") + cmd.MarkFlagRequired("cluster-id") + hybridDataSecurityCmd.AddCommand(cmd) + } + + { // list-nodes-cluster + var clusterId string + cmd := &cobra.Command{ + Use: "list-nodes-cluster", + Short: "List nodes for an Hybrid Data Security cluster", + Long: `Retrieve a list of all nodes for a specific Hybrid Data Security cluster, including availability, proxy details, deployment type, and release version. +To obtain the Cluster ID needed for this API, use the [List clusters for an Hybrid Data Security organization API]()`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/clusters/{clusterId}/nodes") + req.PathParam("clusterId", clusterId) + 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(&clusterId, "cluster-id", "", "Unique ID of the Hybrid Data Security cluster.") + cmd.MarkFlagRequired("cluster-id") + hybridDataSecurityCmd.AddCommand(cmd) + } + + { // get-node + var nodeId string + cmd := &cobra.Command{ + Use: "get-node", + Short: "Get node details", + Long: `Retrieve details for a specific Hybrid Data Security node, such as host name, release version, proxy details, deployment and build type, availability details, etc. +To obtain the Node ID needed for this API, use the [Get cluster details API]()`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/nodes/{nodeId}") + req.PathParam("nodeId", nodeId) + 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(&nodeId, "node-id", "", "Unique ID of the Hybrid Data Security node") + cmd.MarkFlagRequired("node-id") + hybridDataSecurityCmd.AddCommand(cmd) + } + + { // get-database-org + var organizationId string + cmd := &cobra.Command{ + Use: "get-database-org", + Short: "Get database details for the Hybrid Data Security organization", + Long: `Retrieve details of database information for an Hybrid Data Security 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 Hybrid Data Security organization") + cmd.MarkFlagRequired("organization-id") + hybridDataSecurityCmd.AddCommand(cmd) + } + + { // get-multi-tenant-org + var organizationId string + cmd := &cobra.Command{ + Use: "get-multi-tenant-org", + Short: "Get Multi-Tenant Hybrid Data Security organization details", + Long: `Retrieve details of Multi-Tenant Hybrid Data Security 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 Hybrid Data Security organization.") + cmd.MarkFlagRequired("organization-id") + hybridDataSecurityCmd.AddCommand(cmd) + } + + { // get-alarms-node + var nodeId string + var from string + var to string + var last string + cmd := &cobra.Command{ + Use: "get-alarms-node", + Short: "Get alarms for an Hybrid Data Security node", + Long: `Returns the alarm details for a single Hybrid Data Security node for the provided time range (last 24 hours). +To obtain the Node ID needed for this API, use the [List nodes for an Hybrid Data Security cluster API]()`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/nodes/{nodeId}/alarms") + if last != "" { + var err error + from, to, err = timeutil.ParseLastISO(last) + if err != nil { + return err + } + } + req.PathParam("nodeId", nodeId) + req.QueryParam("from", from) + req.QueryParam("to", to) + 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(&nodeId, "node-id", "", "Unique ID of the Hybrid Data Security node.") + cmd.MarkFlagRequired("node-id") + cmd.Flags().StringVar(&from, "from", "", "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.") + cmd.Flags().StringVar(&to, "to", "", "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.") + cmd.Flags().StringVar(&last, "last", "", "Time range shorthand (e.g. 1h, 30m, 24h). Sets --from automatically.") + hybridDataSecurityCmd.AddCommand(cmd) + } + + { // get-test-results-node + var nodeId string + var triggerType string + cmd := &cobra.Command{ + Use: "get-test-results-node", + Short: "Get test results for Hybrid Data Security node", + Long: `Get the latest results of the network tests triggered for a single Hybrid Data Security node. The test results are generated as part of the Network Test execution on the node. The network tests include the Bandwidth Test, DNS Resolution Test, and HTTPS Connectivity Test. + The results from the latest test run are provided, covering up to the past 90 days if available. +To obtain the Node ID needed for this API, use the [Get cluster details API]()`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/testResults/nodes/{nodeId}/networkTest") + req.PathParam("nodeId", nodeId) + req.QueryParam("triggerType", triggerType) + 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(&nodeId, "node-id", "", "Unique ID of the Hybrid Data Security node.") + cmd.MarkFlagRequired("node-id") + cmd.Flags().StringVar(&triggerType, "trigger-type", "", "Trigger type.") + hybridDataSecurityCmd.AddCommand(cmd) + } + + { // get-usage-node + var nodeId string + var from string + var to string + var last string + cmd := &cobra.Command{ + Use: "get-usage-node", + Short: "Get resource usage for an Hybrid Data Security node", + Long: `Retrieve CPU, memory, and disk resource usage details for a specific Hybrid Data Security node over the requested time range. +To obtain the Node ID needed for this API, use the [List nodes for an Hybrid Data Security cluster API]()`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/nodes/{nodeId}/resourceUsage") + if last != "" { + var err error + from, to, err = timeutil.ParseLastISO(last) + if err != nil { + return err + } + } + req.PathParam("nodeId", nodeId) + req.QueryParam("from", from) + req.QueryParam("to", to) + 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(&nodeId, "node-id", "", "Unique ID of the Hybrid Data Security node.") + cmd.MarkFlagRequired("node-id") + cmd.Flags().StringVar(&from, "from", "", "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.") + cmd.Flags().StringVar(&to, "to", "", "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.") + cmd.Flags().StringVar(&last, "last", "", "Time range shorthand (e.g. 1h, 30m, 24h). Sets --from automatically.") + hybridDataSecurityCmd.AddCommand(cmd) + } + + { // get-availability-cluster + var clusterId string + var from string + var to string + var last string + cmd := &cobra.Command{ + Use: "get-availability-cluster", + Short: "Get availability details for Hybrid Data Security cluster", + Long: `Get the availability details for an Hybrid Data Security cluster, where each segment specifies the start and end times, as well as the number of online, offline, and total nodes within that segment. +To obtain the Cluster ID needed for this API, use the [Get organization details API]()`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/clusters/{clusterId}/availability") + if last != "" { + var err error + from, to, err = timeutil.ParseLastISO(last) + if err != nil { + return err + } + } + req.PathParam("clusterId", clusterId) + req.QueryParam("from", from) + req.QueryParam("to", to) + 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(&clusterId, "cluster-id", "", "Unique ID of the Hybrid Data Security cluster.") + cmd.MarkFlagRequired("cluster-id") + cmd.Flags().StringVar(&from, "from", "", "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.") + cmd.Flags().StringVar(&to, "to", "", "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.") + cmd.Flags().StringVar(&last, "last", "", "Time range shorthand (e.g. 1h, 30m, 24h). Sets --from automatically.") + hybridDataSecurityCmd.AddCommand(cmd) + } + +} diff --git a/cmd/messaging/people.go b/cmd/messaging/people.go index dbc56e3..7b454a2 100644 --- a/cmd/messaging/people.go +++ b/cmd/messaging/people.go @@ -153,7 +153,7 @@ func init() { cmd := &cobra.Command{ Use: "update-person", Short: "Update a Person", - Long: "Update details for a person, by ID.\n\nSpecify the person ID in the `personId` parameter in the URI. Only an admin can update a person details.\n\nInclude all details for the person. This action expects all user details to be present in the request. A common approach is to first [GET the person's details](/docs/api/v1/people/get-person-details), make changes, then PUT both the changed and unchanged values.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.\n\nWhen doing attendee management, to update a user from host role to an attendee for a site append `#attendee` to the respective `siteUrl` and remove the meeting host license for this site from the license array.\nTo update a person from an attendee role to a host for a site, add the meeting license for this site in the meeting array, and remove that site from the `siteurl` parameter.\n\nTo remove the attendee privilege for a user on a meeting site, remove the `sitename#attendee` from the `siteUrl`s array. The `showAllTypes` parameter must be set to `true`.\n\n**NOTE**:\n\n* The `locationId` can only be set when assigning a calling license to a user. It cannot be changed if a user is already an existing calling user.\n\n* The `extension` field should be used to update the Webex Calling extension for a person. The extension value should not include the location routing prefix. The `work_extension` type in the `phoneNumbers` object as seen in the response payload of [List People](/docs/api/v1/people/list-people) or [Get Person Details](/docs/api/v1/people/get-person-details), cannot be used to set the Webex Calling extension for a person.\n\n* When updating a user with multiple email addresses using a PUT request, ensure that the primary email address is listed first in the array. Note that the order of email addresses returned by a GET request is not guaranteed..\n\n* The People API is a combination of several microservices, each responsible for specific attributes of a person. As a result, a PUT request that returns an error response code may still have altered some values of the person's data. Therefore, it is recommended to perform a GET request after encountering an error to verify the current state of the resource. \n\n* Some licenses are implicitly assigned by the system and cannot be admin controlled. They are necessary for the baseline function of the Webex system. If you get an error about implicitly assigned licensed that cannot be removed, please ensure you have the corresponding license in your PUT request.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.", + Long: "Update details for a person, by ID.\n\nSpecify the person ID in the `personId` parameter in the URI. Only an admin can update a person details.\n\nInclude all details for the person. This action expects all user details to be present in the request. A common approach is to first [GET the person's details](/docs/api/v1/people/get-person-details), make changes, then PUT both the changed and unchanged values.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.\n\nWhen doing attendee management, to update a user from host role to an attendee for a site append `#attendee` to the respective `siteUrl` and remove the meeting host license for this site from the license array.\nTo update a person from an attendee role to a host for a site, add the meeting license for this site in the meeting array, and remove that site from the `siteurl` parameter.\n\nTo remove the attendee privilege for a user on a meeting site, remove the `sitename#attendee` from the `siteUrl`s array. The `showAllTypes` parameter must be set to `true`.\n\n**NOTE**:\n\n* When assigning a Webex Calling license, either a telephone number or extension must already be assigned to the person or provided in the request payload.\n\n* When `callingData` is set to `true`, a Webex Calling license must be included in the `licenses` array.\n\n* The `locationId` can only be set when assigning a calling license to a user. It cannot be changed if a user is already an existing calling user.\n\n* The `extension` field should be used to update the Webex Calling extension for a person. The extension value should not include the location routing prefix. The `work_extension` type in the `phoneNumbers` object as seen in the response payload of [List People](/docs/api/v1/people/list-people) or [Get Person Details](/docs/api/v1/people/get-person-details), cannot be used to set the Webex Calling extension for a person.\n\n* When updating a user with multiple email addresses using a PUT request, ensure that the primary email address is listed first in the array. Note that the order of email addresses returned by a GET request is not guaranteed..\n\n* The People API is a combination of several microservices, each responsible for specific attributes of a person. As a result, a PUT request that returns an error response code may still have altered some values of the person's data. Therefore, it is recommended to perform a GET request after encountering an error to verify the current state of the resource. \n\n* Some licenses are implicitly assigned by the system and cannot be admin controlled. They are necessary for the baseline function of the Webex system. If you get an error about implicitly assigned licensed that cannot be removed, please ensure you have the corresponding license in your PUT request.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/people/{personId}") req.PathParam("personId", personId) diff --git a/codegen/postman/Webex Admin.postman_collection.json b/codegen/postman/Webex Admin.postman_collection.json index 38591e2..003f9ab 100644 --- a/codegen/postman/Webex Admin.postman_collection.json +++ b/codegen/postman/Webex Admin.postman_collection.json @@ -3930,7 +3930,7 @@ }, "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.", + "description": "Register a data source with the Webex BYODS system. Authenticate using a Service App with the `spark-admin:datasource_write` scope.\nSchema IDs determine the types of data Webex sends to the DAP and the expected responses. Use the Data Source Schemas endpoints to inspect the available schemas.", "header": [ { "key": "Content-Type", @@ -4559,7 +4559,7 @@ { "name": "Retrieve All Data Sources", "request": { - "description": "Show all data sources registered for this Service App with the scope `spark-admin:datasource_read`.", + "description": "Lists all data sources registered by the Service App. Requires the `spark-admin:datasource_read` scope.", "header": [ { "key": "Accept", @@ -4945,7 +4945,7 @@ { "name": "Retrieve Data Source Schemas", "request": { - "description": "Show available schemas. No specific scope is needed to retrieve the dataSource schemas, but a valid API token should be presented.", + "description": "Lists the available data source schemas. A valid API access token is required, but no specific scope is needed.", "header": [ { "key": "Accept", @@ -5348,7 +5348,7 @@ { "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.", + "description": "Retrieves details for a specific data source schema by schema ID. A valid API access token is required, but no specific scope is needed.", "header": [ { "key": "Accept", @@ -5871,7 +5871,7 @@ { "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.", + "description": "Deletes a data source by ID.\n\nSpecify the data source ID in the `dataSourceId` URI parameter.", "header": [], "method": "DELETE", "url": { @@ -5885,7 +5885,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId", "value": "" } @@ -5914,7 +5914,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -5943,7 +5943,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -5972,7 +5972,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6001,7 +6001,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6030,7 +6030,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6059,7 +6059,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6088,7 +6088,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6117,7 +6117,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6146,7 +6146,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6175,7 +6175,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6204,7 +6204,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6233,7 +6233,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6262,7 +6262,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6291,7 +6291,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6320,7 +6320,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6349,7 +6349,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6362,7 +6362,7 @@ { "name": "Retrieve Data Source Details", "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": "Retrieves details for a data source by ID. Use a Service App token with the `spark-admin:datasource_read` scope.", "header": [ { "key": "Accept", @@ -6381,7 +6381,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId", "value": "" } @@ -6410,7 +6410,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6449,7 +6449,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6478,7 +6478,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6507,7 +6507,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6536,7 +6536,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6565,7 +6565,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6594,7 +6594,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6623,7 +6623,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6652,7 +6652,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6681,7 +6681,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6710,7 +6710,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6739,7 +6739,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6768,7 +6768,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6797,7 +6797,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6826,7 +6826,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6855,7 +6855,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -6878,7 +6878,7 @@ }, "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.", + "description": "Updates a data source. The fields you can update are `audience`, `subject`, `nonce`, `url`, and `tokenLifetimeMinutes`.\nYou can set `status` from `active` to `disabled` only if you provide an `errorMessage`, which may be shown to the customer administrator in Control Hub.\nUpdate tokens before they expire to prevent service interruption.", "header": [ { "key": "Content-Type", @@ -13629,558 +13629,528 @@ "status": "Unauthorized" } ] - } - ], - "name": "Identity Organization" - }, - { - "item": [ + }, { - "name": "List Events", + "name": "Update Organization Authentication Configuration Settings", "request": { - "description": "List events in your organization. Several query parameters are available to filter the events returned in the response.\n\nLong result sets will be split into [pages](/docs/basics#pagination).", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, + "description": "Update the authentication configuration details, by organizationID.\nSpecify the organization ID in the `orgId` parameter in the URI.\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:organizations_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n
\n\n**Usage**:\n\n1. Input JSON must contain schema: \"urn:cisco:codev:identity:idbroker:authnconfig:schemas:1.0\".", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events" + "identity", + "organizations", + ":orgId", + "authenticationConfig" ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, - { - "description": "List events performed by this person, by person ID.", - "key": "actorId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "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.", - "key": "to", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" - }, - { - "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&serviceType=calling" + ] } }, "response": [ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events" + "identity", + "organizations", + ":orgId", + "authenticationConfig" ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, - { - "description": "List events performed by this person, by person ID.", - "key": "actorId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "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.", - "key": "to", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" - }, - { - "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&serviceType=calling" + ] } }, - "status": "Not Found" + "status": "Service Unavailable" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events" + "identity", + "organizations", + ":orgId", + "authenticationConfig" ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, - { - "description": "List events performed by this person, by person ID.", - "key": "actorId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "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.", - "key": "to", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" - }, - { - "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&serviceType=calling" + ] } }, - "status": "Gone" + "status": "Internal Server Error" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events" + "identity", + "organizations", + ":orgId", + "authenticationConfig" ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, - { - "description": "List events performed by this person, by person ID.", - "key": "actorId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "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.", - "key": "to", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" - }, - { - "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&serviceType=calling" + ] } }, - "status": "Service Unavailable" + "status": "Precondition Required" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events" + "identity", + "organizations", + ":orgId", + "authenticationConfig" ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, - { - "description": "List events performed by this person, by person ID.", - "key": "actorId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "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.", - "key": "to", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" - }, - { - "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&serviceType=calling" + ] } }, - "status": "Gateway Timeout" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events" + "identity", + "organizations", + ":orgId", + "authenticationConfig" ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, - { - "description": "List events performed by this person, by person ID.", - "key": "actorId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "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.", - "key": "to", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" - }, - { - "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&serviceType=calling" + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 401, "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": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events" + "identity", + "organizations", + ":orgId", + "authenticationConfig" ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, - { - "description": "List events performed by this person, by person ID.", - "key": "actorId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "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.", - "key": "to", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" - }, - { - "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&serviceType=calling" + ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_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": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "events" - ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "identity", + "organizations", + ":orgId", + "authenticationConfig" + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "List events performed by this person, by person ID.", - "key": "actorId", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" - }, + } + ] + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "identity", + "organizations", + ":orgId", + "authenticationConfig" + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "List events which occurred after a specific date and time.", - "key": "from", + "description": "A unique identifier for the org.", + "key": "orgId", "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "identity", + "organizations", + ":orgId", + "authenticationConfig" + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "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.", - "key": "to", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" - }, - { - "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&serviceType=calling" + ] } }, - "status": "Precondition Required" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"resource\": \"tabs\",\n \"type\": \"updated\",\n \"actorId\": \"\",\n \"orgId\": \"\",\n \"created\": \"\",\n \"data\": {\n \"id\": \"\",\n \"roomId\": \"\",\n \"roomType\": \"\",\n \"orgId\": \"\",\n \"text\": \"\",\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"meetingId\": \"\",\n \"creatorId\": \"\",\n \"host\": {},\n \"transcriptionEnabled\": \"\",\n \"recordingEnabled\": \"\",\n \"hasPostMeetingsChat\": \"\",\n \"corelationId\": \"\",\n \"callType\": \"\",\n \"userId\": \"\",\n \"userType\": \"\",\n \"callDirection\": \"\",\n \"isCallAnswered\": \"\",\n \"callDurationSeconds\": \"\",\n \"callStartTime\": \"\",\n \"callAnswerTime\": \"\",\n \"callTransferTime\": \"\",\n \"callingNumber\": \"\",\n \"callingLineId\": \"\",\n \"calledNumber\": \"\",\n \"calledLineId\": \"\",\n \"dialedDigits\": \"\",\n \"callRedirectingNumber\": \"\",\n \"callRedirectedReason\": \"\",\n \"created\": \"\",\n \"type\": \"\",\n \"breakoutSessionId\": \"\",\n \"recipients\": [\n {\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"guestDisplayName\": \"\",\n \"guestEmail\": \"\"\n },\n {\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"guestDisplayName\": \"\",\n \"guestEmail\": \"\"\n }\n ]\n },\n \"appId\": \"\"\n },\n {\n \"id\": \"\",\n \"resource\": \"file_transcodings\",\n \"type\": \"deleted\",\n \"actorId\": \"\",\n \"orgId\": \"\",\n \"created\": \"\",\n \"data\": {\n \"id\": \"\",\n \"roomId\": \"\",\n \"roomType\": \"\",\n \"orgId\": \"\",\n \"text\": \"\",\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"meetingId\": \"\",\n \"creatorId\": \"\",\n \"host\": {},\n \"transcriptionEnabled\": \"\",\n \"recordingEnabled\": \"\",\n \"hasPostMeetingsChat\": \"\",\n \"corelationId\": \"\",\n \"callType\": \"\",\n \"userId\": \"\",\n \"userType\": \"\",\n \"callDirection\": \"\",\n \"isCallAnswered\": \"\",\n \"callDurationSeconds\": \"\",\n \"callStartTime\": \"\",\n \"callAnswerTime\": \"\",\n \"callTransferTime\": \"\",\n \"callingNumber\": \"\",\n \"callingLineId\": \"\",\n \"calledNumber\": \"\",\n \"calledLineId\": \"\",\n \"dialedDigits\": \"\",\n \"callRedirectingNumber\": \"\",\n \"callRedirectedReason\": \"\",\n \"created\": \"\",\n \"type\": \"\",\n \"breakoutSessionId\": \"\",\n \"recipients\": [\n {\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"guestDisplayName\": \"\",\n \"guestEmail\": \"\"\n },\n {\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"guestDisplayName\": \"\",\n \"guestEmail\": \"\"\n }\n ]\n },\n \"appId\": \"\"\n }\n ]\n}", + "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"LockoutDuration\": \"\",\n \"LockoutDurationMultiplier\": \"\",\n \"LockoutFailureCount\": \"\",\n \"LockoutFailureDuration\": \"\",\n \"RememberMyLoginId\": \"\",\n \"mfaEnabled\": \"\",\n \"RememberMyLoginIdDuration\": \"\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" } ], "name": "OK", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events" + "identity", + "organizations", + ":orgId", + "authenticationConfig" ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, - { - "description": "List events performed by this person, by person ID.", - "key": "actorId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "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.", - "key": "to", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" - }, - { - "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&serviceType=calling" + ] } }, "status": "OK" @@ -14193,53 +14163,41 @@ "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events" + "identity", + "organizations", + ":orgId", + "authenticationConfig" ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, - { - "description": "List events performed by this person, by person ID.", - "key": "actorId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "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.", - "key": "to", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" - }, - { - "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&serviceType=calling" + ] } }, "status": "Conflict" @@ -14247,442 +14205,280 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 400, "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": "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events" + "identity", + "organizations", + ":orgId", + "authenticationConfig" ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, - { - "description": "List events performed by this person, by person ID.", - "key": "actorId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "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.", - "key": "to", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" - }, - { - "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&serviceType=calling" + ] } }, - "status": "Too Many Requests" + "status": "Bad Request" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events" + "identity", + "organizations", + ":orgId", + "authenticationConfig" ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, - { - "description": "List events performed by this person, by person ID.", - "key": "actorId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "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.", - "key": "to", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" - }, - { - "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&serviceType=calling" + ] } }, - "status": "Method Not Allowed" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 415, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. 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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events" + "identity", + "organizations", + ":orgId", + "authenticationConfig" ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, - { - "description": "List events performed by this person, by person ID.", - "key": "actorId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "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.", - "key": "to", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" - }, - { - "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&serviceType=calling" + ] } }, - "status": "Bad Gateway" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 504, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events" + "identity", + "organizations", + ":orgId", + "authenticationConfig" ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, - { - "description": "List events performed by this person, by person ID.", - "key": "actorId", - "value": "" - }, + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "List events which occurred after a specific date and time.", - "key": "from", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" - }, - { - "description": "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.", - "key": "to", - "value": "" - }, - { - "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&serviceType=calling" - } - }, - "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": [ - "events" - ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, - { - "description": "List events performed by this person, by person ID.", - "key": "actorId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "from", - "value": "" - }, - { - "description": "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.", - "key": "to", - "value": "" - }, - { - "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&serviceType=calling" + ] } }, - "status": "Bad Request" + "status": "Gateway Timeout" }, { "_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": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "events" - ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, - { - "description": "List events performed by this person, by person ID.", - "key": "actorId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "from", - "value": "" - }, - { - "description": "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.", - "key": "to", - "value": "" - }, - { - "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" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } - ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" - } - }, - "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", + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"RememberMyLoginId\": \"\",\n \"RememberMyLoginIdDuration\": \"\",\n \"mfaEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events" + "identity", + "organizations", + ":orgId", + "authenticationConfig" ], - "query": [ - { - "description": "List events with a specific resource type.", - "key": "resource", - "value": "rooms" - }, - { - "description": "List events with a specific event type.", - "key": "type", - "value": "deleted" - }, - { - "description": "List events performed by this person, by person ID.", - "key": "actorId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/identity/organizations/:orgId/authenticationConfig", + "variable": [ { - "description": "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.", - "key": "to", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" - }, - { - "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&serviceType=calling" + ] } }, - "status": "Unauthorized" + "status": "Gone" } ] }, { - "name": "Get Event Details", + "name": "Update Organization Password Policy", "request": { - "description": "Shows details for an event, by event ID.\n\nSpecify the event ID in the `eventId` parameter in the URI.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" + }, + "description": "Update Organization Password Policy, by organizationID.\nSpecify the organization ID in the `orgId` parameter in the URI.\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:organizations_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n
\n\n**Usage**:\n\n1. Input JSON must contain schema: \"urn:cisco:codev:identity:idbroker:pwdpolicy:schemas:1.0\".", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events", - ":eventId" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/events/:eventId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", "variable": [ { - "description": "The unique identifier for the event.", - "key": "eventId", + "description": "A unique identifier for the org.", + "key": "orgId", "value": "" } ] @@ -14692,60 +14488,96 @@ { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events", - ":eventId" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/events/:eventId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", "variable": [ { - "description": "The unique identifier for the event.", - "key": "eventId" + "description": "A unique identifier for the org.", + "key": "orgId", + "value": "" } ] } }, - "status": "Unauthorized" + "status": "Bad Gateway" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events", - ":eventId" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/events/:eventId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", "variable": [ { - "description": "The unique identifier for the event.", - "key": "eventId" + "description": "A unique identifier for the org.", + "key": "orgId", + "value": "" } ] } }, - "status": "Service Unavailable" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", @@ -14755,21 +14587,39 @@ "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events", - ":eventId" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/events/:eventId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", "variable": [ { - "description": "The unique identifier for the event.", - "key": "eventId" + "description": "A unique identifier for the org.", + "key": "orgId", + "value": "" } ] } @@ -14779,60 +14629,96 @@ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events", - ":eventId" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/events/:eventId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", "variable": [ { - "description": "The unique identifier for the event.", - "key": "eventId" + "description": "A unique identifier for the org.", + "key": "orgId", + "value": "" } ] } }, - "status": "Gateway Timeout" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 423, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events", - ":eventId" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/events/:eventId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", "variable": [ { - "description": "The unique identifier for the event.", - "key": "eventId" + "description": "A unique identifier for the org.", + "key": "orgId", + "value": "" } ] } }, - "status": "Forbidden" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", @@ -14842,21 +14728,39 @@ "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events", - ":eventId" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/events/:eventId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", "variable": [ { - "description": "The unique identifier for the event.", - "key": "eventId" + "description": "A unique identifier for the org.", + "key": "orgId", + "value": "" } ] } @@ -14866,171 +14770,138 @@ { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events", - ":eventId" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/events/:eventId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", "variable": [ { - "description": "The unique identifier for the event.", - "key": "eventId" + "description": "A unique identifier for the org.", + "key": "orgId", + "value": "" } ] } }, - "status": "Gone" + "status": "Gateway Timeout" }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events", - ":eventId" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/events/:eventId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", "variable": [ { - "description": "The unique identifier for the event.", - "key": "eventId" + "description": "A unique identifier for the org.", + "key": "orgId", + "value": "" } ] } }, - "status": "Bad Gateway" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 429, "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": "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events", - ":eventId" - ], - "raw": "{{baseUrl}}/events/:eventId", - "variable": [ - { - "description": "The unique identifier for the event.", - "key": "eventId" - } - ] - } - }, - "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": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "events", - ":eventId" - ], - "raw": "{{baseUrl}}/events/:eventId", - "variable": [ - { - "description": "The unique identifier for the event.", - "key": "eventId" - } - ] - } - }, - "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": [ - "events", - ":eventId" - ], - "raw": "{{baseUrl}}/events/:eventId", - "variable": [ - { - "description": "The unique identifier for the event.", - "key": "eventId" - } - ] - } - }, - "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": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "events", - ":eventId" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/events/:eventId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", "variable": [ { - "description": "The unique identifier for the event.", - "key": "eventId" + "description": "A unique identifier for the org.", + "key": "orgId", + "value": "" } ] } @@ -15040,35 +14911,53 @@ { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events", - ":eventId" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/events/:eventId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", "variable": [ { - "description": "The unique identifier for the event.", - "key": "eventId" + "description": "A unique identifier for the org.", + "key": "orgId", + "value": "" } ] } }, - "status": "Method Not Allowed" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"resource\": \"tabs\",\n \"type\": \"created\",\n \"actorId\": \"\",\n \"orgId\": \"\",\n \"created\": \"\",\n \"data\": {\n \"id\": \"\",\n \"roomId\": \"\",\n \"roomType\": \"\",\n \"orgId\": \"\",\n \"text\": \"\",\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"meetingId\": \"\",\n \"creatorId\": \"\",\n \"host\": {},\n \"attendees\": [\n \"\",\n \"\"\n ],\n \"transcriptionEnabled\": \"\",\n \"recordingEnabled\": \"\",\n \"hasPostMeetingsChat\": \"\",\n \"corelationId\": \"\",\n \"callType\": \"\",\n \"userId\": \"\",\n \"userType\": \"\",\n \"callDirection\": \"\",\n \"isCallAnswered\": \"\",\n \"callDurationSeconds\": \"\",\n \"callStartTime\": \"\",\n \"callAnswerTime\": \"\",\n \"callTransferTime\": \"\",\n \"callingNumber\": \"\",\n \"callingLineId\": \"\",\n \"calledNumber\": \"\",\n \"calledLineId\": \"\",\n \"dialedDigits\": \"\",\n \"callRedirectingNumber\": \"\",\n \"callRedirectedReason\": \"\",\n \"created\": \"\",\n \"type\": \"\",\n \"breakoutSessionId\": \"\",\n \"recipients\": [\n {\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"guestDisplayName\": \"\",\n \"guestEmail\": \"\"\n },\n {\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"guestDisplayName\": \"\",\n \"guestEmail\": \"\"\n }\n ]\n },\n \"appId\": \"\"\n}", + "body": "{\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -15079,26 +14968,43 @@ ], "name": "OK", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "events", - ":eventId" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/events/:eventId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", "variable": [ { - "description": "The unique identifier for the event.", - "key": "eventId" + "description": "A unique identifier for the org.", + "key": "orgId", + "value": "" } ] } @@ -15108,111 +15014,10 @@ { "_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": [ - "events", - ":eventId" - ], - "raw": "{{baseUrl}}/events/:eventId", - "variable": [ - { - "description": "The unique identifier for the event.", - "key": "eventId" - } - ] - } - }, - "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": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "events", - ":eventId" - ], - "raw": "{{baseUrl}}/events/:eventId", - "variable": [ - { - "description": "The unique identifier for the event.", - "key": "eventId" - } - ] - } - }, - "status": "Precondition Required" - } - ] - } - ], - "name": "Events" - }, - { - "item": [ - { - "name": "Create a Group", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "description": "Create a new group for a given organization. The group may optionally be created with group members.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "groups" - ], - "raw": "{{baseUrl}}/groups" - } - }, - "response": [ - { - "_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", @@ -15222,7 +15027,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" }, "header": [ { @@ -15230,26 +15035,36 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/groups" + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", + "variable": [ + { + "description": "A unique identifier for the org.", + "key": "orgId", + "value": "" + } + ] } }, - "status": "Precondition Required" + "status": "Not Found" }, { "_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": { "body": { "mode": "raw", @@ -15259,7 +15074,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" }, "header": [ { @@ -15267,26 +15082,36 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/groups" + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", + "variable": [ + { + "description": "A unique identifier for the org.", + "key": "orgId", + "value": "" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 503, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -15296,7 +15121,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" }, "header": [ { @@ -15304,26 +15129,36 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/groups" + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", + "variable": [ + { + "description": "A unique identifier for the org.", + "key": "orgId", + "value": "" + } + ] } }, - "status": "Unauthorized" + "status": "Service Unavailable" }, { "_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", @@ -15333,7 +15168,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" }, "header": [ { @@ -15341,26 +15176,36 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/groups" + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", + "variable": [ + { + "description": "A unique identifier for the org.", + "key": "orgId", + "value": "" + } + ] } }, - "status": "Unsupported Media Type" + "status": "Gone" }, { "_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": { "body": { "mode": "raw", @@ -15370,7 +15215,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"minimumNumeric\": \"\",\n \"minimumCapAlpha\": \"\",\n \"minimumLowAlpha\": \"\",\n \"minimumSpecial\": \"\",\n \"minimumLength\": \"\",\n \"historyCount\": \"\",\n \"maxPasswordAge\": \"\",\n \"notAcceptableStrings\": \"\"\n}" }, "header": [ { @@ -15378,564 +15223,644 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups" + "identity", + "organizations", + ":orgId", + "passwordPolicy" ], - "raw": "{{baseUrl}}/groups" + "raw": "{{baseUrl}}/identity/organizations/:orgId/passwordPolicy", + "variable": [ + { + "description": "A unique identifier for the org.", + "key": "orgId", + "value": "" + } + ] } }, - "status": "Not Found" - }, + "status": "Unauthorized" + } + ] + } + ], + "name": "Identity Organization" + }, + { + "item": [ + { + "name": "List Events", + "request": { + "description": "List events in your organization. Several query parameters are available to filter the events returned in the response.\n\nLong result sets will be split into [pages](/docs/basics#pagination).", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "events" + ], + "query": [ + { + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" + }, + { + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" + }, + { + "description": "List events performed by this person, by person ID.", + "key": "actorId", + "value": "" + }, + { + "description": "List events which occurred after a specific date and time.", + "key": "from", + "value": "" + }, + { + "description": "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.", + "key": "to", + "value": "" + }, + { + "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&serviceType=calling" + } + }, + "response": [ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups" + "events" ], - "raw": "{{baseUrl}}/groups" + "query": [ + { + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" + }, + { + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" + }, + { + "description": "List events performed by this person, by person ID.", + "key": "actorId", + "value": "" + }, + { + "description": "List events which occurred after a specific date and time.", + "key": "from", + "value": "" + }, + { + "description": "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.", + "key": "to", + "value": "" + }, + { + "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&serviceType=calling" } }, - "status": "Gone" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 410, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups" + "events" ], - "raw": "{{baseUrl}}/groups" - } - }, - "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" + "query": [ + { + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" + }, + { + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" + }, + { + "description": "List events performed by this person, by person ID.", + "key": "actorId", + "value": "" + }, + { + "description": "List events which occurred after a specific date and time.", + "key": "from", + "value": "" + }, + { + "description": "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.", + "key": "to", + "value": "" + }, + { + "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": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" ], - "path": [ - "groups" - ], - "raw": "{{baseUrl}}/groups" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, - "status": "Internal Server Error" + "status": "Gone" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups" + "events" ], - "raw": "{{baseUrl}}/groups" + "query": [ + { + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" + }, + { + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" + }, + { + "description": "List events performed by this person, by person ID.", + "key": "actorId", + "value": "" + }, + { + "description": "List events which occurred after a specific date and time.", + "key": "from", + "value": "" + }, + { + "description": "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.", + "key": "to", + "value": "" + }, + { + "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&serviceType=calling" } }, - "status": "Method Not Allowed" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 504, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups" + "events" ], - "raw": "{{baseUrl}}/groups" + "query": [ + { + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" + }, + { + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" + }, + { + "description": "List events performed by this person, by person ID.", + "key": "actorId", + "value": "" + }, + { + "description": "List events which occurred after a specific date and time.", + "key": "from", + "value": "" + }, + { + "description": "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.", + "key": "to", + "value": "" + }, + { + "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&serviceType=calling" } }, - "status": "Forbidden" + "status": "Gateway Timeout" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups" + "events" ], - "raw": "{{baseUrl}}/groups" + "query": [ + { + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" + }, + { + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" + }, + { + "description": "List events performed by this person, by person ID.", + "key": "actorId", + "value": "" + }, + { + "description": "List events which occurred after a specific date and time.", + "key": "from", + "value": "" + }, + { + "description": "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.", + "key": "to", + "value": "" + }, + { + "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&serviceType=calling" } }, - "status": "Bad Gateway" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups" + "events" ], - "raw": "{{baseUrl}}/groups" + "query": [ + { + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" + }, + { + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" + }, + { + "description": "List events performed by this person, by person ID.", + "key": "actorId", + "value": "" + }, + { + "description": "List events which occurred after a specific date and time.", + "key": "from", + "value": "" + }, + { + "description": "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.", + "key": "to", + "value": "" + }, + { + "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&serviceType=calling" } }, - "status": "Conflict" + "status": "Internal Server Error" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups" + "events" ], - "raw": "{{baseUrl}}/groups" + "query": [ + { + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" + }, + { + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" + }, + { + "description": "List events performed by this person, by person ID.", + "key": "actorId", + "value": "" + }, + { + "description": "List events which occurred after a specific date and time.", + "key": "from", + "value": "" + }, + { + "description": "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.", + "key": "to", + "value": "" + }, + { + "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&serviceType=calling" } }, - "status": "Too Many Requests" + "status": "Precondition Required" }, { "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"displayName\": \"\",\n \"orgId\": \"\",\n \"created\": \"\",\n \"lastModified\": \"\",\n \"memberSize\": \"\",\n \"members\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n }\n ]\n}", - "code": 201, + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"resource\": \"tabs\",\n \"type\": \"updated\",\n \"actorId\": \"\",\n \"orgId\": \"\",\n \"created\": \"\",\n \"data\": {\n \"id\": \"\",\n \"roomId\": \"\",\n \"roomType\": \"\",\n \"orgId\": \"\",\n \"text\": \"\",\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"meetingId\": \"\",\n \"creatorId\": \"\",\n \"host\": {},\n \"transcriptionEnabled\": \"\",\n \"recordingEnabled\": \"\",\n \"hasPostMeetingsChat\": \"\",\n \"corelationId\": \"\",\n \"callType\": \"\",\n \"userId\": \"\",\n \"userType\": \"\",\n \"callDirection\": \"\",\n \"isCallAnswered\": \"\",\n \"callDurationSeconds\": \"\",\n \"callStartTime\": \"\",\n \"callAnswerTime\": \"\",\n \"callTransferTime\": \"\",\n \"callingNumber\": \"\",\n \"callingLineId\": \"\",\n \"calledNumber\": \"\",\n \"calledLineId\": \"\",\n \"dialedDigits\": \"\",\n \"callRedirectingNumber\": \"\",\n \"callRedirectedReason\": \"\",\n \"created\": \"\",\n \"type\": \"\",\n \"breakoutSessionId\": \"\",\n \"recipients\": [\n {\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"guestDisplayName\": \"\",\n \"guestEmail\": \"\"\n },\n {\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"guestDisplayName\": \"\",\n \"guestEmail\": \"\"\n }\n ]\n },\n \"appId\": \"\"\n },\n {\n \"id\": \"\",\n \"resource\": \"file_transcodings\",\n \"type\": \"deleted\",\n \"actorId\": \"\",\n \"orgId\": \"\",\n \"created\": \"\",\n \"data\": {\n \"id\": \"\",\n \"roomId\": \"\",\n \"roomType\": \"\",\n \"orgId\": \"\",\n \"text\": \"\",\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"meetingId\": \"\",\n \"creatorId\": \"\",\n \"host\": {},\n \"transcriptionEnabled\": \"\",\n \"recordingEnabled\": \"\",\n \"hasPostMeetingsChat\": \"\",\n \"corelationId\": \"\",\n \"callType\": \"\",\n \"userId\": \"\",\n \"userType\": \"\",\n \"callDirection\": \"\",\n \"isCallAnswered\": \"\",\n \"callDurationSeconds\": \"\",\n \"callStartTime\": \"\",\n \"callAnswerTime\": \"\",\n \"callTransferTime\": \"\",\n \"callingNumber\": \"\",\n \"callingLineId\": \"\",\n \"calledNumber\": \"\",\n \"calledLineId\": \"\",\n \"dialedDigits\": \"\",\n \"callRedirectingNumber\": \"\",\n \"callRedirectedReason\": \"\",\n \"created\": \"\",\n \"type\": \"\",\n \"breakoutSessionId\": \"\",\n \"recipients\": [\n {\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"guestDisplayName\": \"\",\n \"guestEmail\": \"\"\n },\n {\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"guestDisplayName\": \"\",\n \"guestEmail\": \"\"\n }\n ]\n },\n \"appId\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" } ], - "name": "Created", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups" + "events" ], - "raw": "{{baseUrl}}/groups" + "query": [ + { + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" + }, + { + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" + }, + { + "description": "List events performed by this person, by person ID.", + "key": "actorId", + "value": "" + }, + { + "description": "List events which occurred after a specific date and time.", + "key": "from", + "value": "" + }, + { + "description": "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.", + "key": "to", + "value": "" + }, + { + "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&serviceType=calling" } }, - "status": "Created" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 409, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. 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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups" - ], - "raw": "{{baseUrl}}/groups" - } - }, - "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "groups" - ], - "raw": "{{baseUrl}}/groups" - } - }, - "status": "Gateway Timeout" - } - ] - }, - { - "name": "List and Search Groups", - "request": { - "description": "List groups in your organization.\n\n* Set the `includeMembers` parameter to `true` to return group members. The total number of members returned is limited to 500.\n\n* Use the `startIndex` and `count` parameters to page through result set.\n\n* To search for a specific group use the `filter` parameter.\n\n* Use `sortBy` parameter to sort the responses by `id` or `displayName`.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "groups" - ], - "query": [ - { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", - "value": "" - }, - { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, - { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" - } - ], - "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" - } - }, - "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": [ - "groups" + "events" ], "query": [ { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" }, { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" }, { - "description": "The attributes to return.", - "key": "attributes", + "description": "List events performed by this person, by person ID.", + "key": "actorId", "value": "" }, { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", + "description": "List events which occurred after a specific date and time.", + "key": "from", "value": "" }, { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", + "description": "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.", + "key": "to", "value": "" }, { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, - { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" + "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", + "key": "max", + "value": "100" }, { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" + "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}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Conflict" }, { "_postman_previewlanguage": "text", @@ -15952,51 +15877,46 @@ "{{baseUrl}}" ], "path": [ - "groups" + "events" ], "query": [ { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" }, { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" }, { - "description": "The attributes to return.", - "key": "attributes", + "description": "List events performed by this person, by person ID.", + "key": "actorId", "value": "" }, { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", + "description": "List events which occurred after a specific date and time.", + "key": "from", "value": "" }, { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", + "description": "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.", + "key": "to", "value": "" }, { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, - { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" + "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", + "key": "max", + "value": "100" }, { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" + "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}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "Too Many Requests" @@ -16004,10 +15924,10 @@ { "_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": { "header": [], "method": "GET", @@ -16016,62 +15936,57 @@ "{{baseUrl}}" ], "path": [ - "groups" + "events" ], "query": [ { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" }, { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" }, { - "description": "The attributes to return.", - "key": "attributes", + "description": "List events performed by this person, by person ID.", + "key": "actorId", "value": "" }, { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", + "description": "List events which occurred after a specific date and time.", + "key": "from", "value": "" }, { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", + "description": "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.", + "key": "to", "value": "" }, { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, - { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" + "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", + "key": "max", + "value": "100" }, { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" + "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}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, - "status": "Gone" + "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. 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": { "header": [], "method": "GET", @@ -16080,62 +15995,57 @@ "{{baseUrl}}" ], "path": [ - "groups" + "events" ], "query": [ { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" }, { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" }, { - "description": "The attributes to return.", - "key": "attributes", + "description": "List events performed by this person, by person ID.", + "key": "actorId", "value": "" }, { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", + "description": "List events which occurred after a specific date and time.", + "key": "from", "value": "" }, { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", + "description": "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.", + "key": "to", "value": "" }, { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, - { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" + "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", + "key": "max", + "value": "100" }, { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" + "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}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, - "status": "Bad Request" + "status": "Bad Gateway" }, { "_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": { "header": [], "method": "GET", @@ -16144,62 +16054,57 @@ "{{baseUrl}}" ], "path": [ - "groups" + "events" ], "query": [ { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" }, { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" }, { - "description": "The attributes to return.", - "key": "attributes", + "description": "List events performed by this person, by person ID.", + "key": "actorId", "value": "" }, { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", + "description": "List events which occurred after a specific date and time.", + "key": "from", "value": "" }, { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", + "description": "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.", + "key": "to", "value": "" }, { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, - { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" + "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", + "key": "max", + "value": "100" }, { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" + "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}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_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", @@ -16208,62 +16113,57 @@ "{{baseUrl}}" ], "path": [ - "groups" + "events" ], "query": [ { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" }, { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" }, { - "description": "The attributes to return.", - "key": "attributes", + "description": "List events performed by this person, by person ID.", + "key": "actorId", "value": "" }, { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", + "description": "List events which occurred after a specific date and time.", + "key": "from", "value": "" }, { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", + "description": "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.", + "key": "to", "value": "" }, { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, - { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" + "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", + "key": "max", + "value": "100" }, { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" + "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}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_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", @@ -16272,62 +16172,57 @@ "{{baseUrl}}" ], "path": [ - "groups" + "events" ], "query": [ { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" }, { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" }, { - "description": "The attributes to return.", - "key": "attributes", + "description": "List events performed by this person, by person ID.", + "key": "actorId", "value": "" }, { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", + "description": "List events which occurred after a specific date and time.", + "key": "from", "value": "" }, { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", + "description": "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.", + "key": "to", "value": "" }, { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, - { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" + "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", + "key": "max", + "value": "100" }, { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" + "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}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, - "status": "Precondition Required" + "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", @@ -16336,118 +16231,139 @@ "{{baseUrl}}" ], "path": [ - "groups" + "events" ], "query": [ { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" + "description": "List events with a specific resource type.", + "key": "resource", + "value": "rooms" }, { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" + "description": "List events with a specific event type.", + "key": "type", + "value": "deleted" }, { - "description": "The attributes to return.", - "key": "attributes", + "description": "List events performed by this person, by person ID.", + "key": "actorId", "value": "" }, { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", + "description": "List events which occurred after a specific date and time.", + "key": "from", "value": "" }, { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", + "description": "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.", + "key": "to", "value": "" }, { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, - { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" + "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", + "key": "max", + "value": "100" }, { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" + "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}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, - "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": [ - "groups" + "status": "Unauthorized" + } + ] + }, + { + "name": "Get Event Details", + "request": { + "description": "Shows details for an event, by event ID.\n\nSpecify the event ID in the `eventId` parameter in the URI.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "events", + ":eventId" + ], + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ + { + "description": "The unique identifier for the event.", + "key": "eventId", + "value": "" + } + ] + } + }, + "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}}" ], - "query": [ - { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", - "value": "" - }, - { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, - { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, + "path": [ + "events", + ":eventId" + ], + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" + "description": "The unique identifier for the event.", + "key": "eventId" } + ] + } + }, + "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}}" ], - "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" + "path": [ + "events", + ":eventId" + ], + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ + { + "description": "The unique identifier for the event.", + "key": "eventId" + } + ] } }, - "status": "Gateway Timeout" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", @@ -16464,51 +16380,16 @@ "{{baseUrl}}" ], "path": [ - "groups" + "events", + ":eventId" ], - "query": [ - { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", - "value": "" - }, - { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, - { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" + "description": "The unique identifier for the event.", + "key": "eventId" } - ], - "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" + ] } }, "status": "Unsupported Media Type" @@ -16516,10 +16397,10 @@ { "_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", @@ -16528,136 +16409,56 @@ "{{baseUrl}}" ], "path": [ - "groups" + "events", + ":eventId" ], - "query": [ - { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", - "value": "" - }, - { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, - { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" + "description": "The unique identifier for the event.", + "key": "eventId" } - ], - "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" + ] } }, - "status": "Bad Gateway" + "status": "Gateway Timeout" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"totalResults\": \"\",\n \"startIndex\": \"\",\n \"itemsPerPage\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"orgId\": \"\",\n \"created\": \"\",\n \"lastModified\": \"\",\n \"memberSize\": \"\",\n \"members\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"orgId\": \"\",\n \"created\": \"\",\n \"lastModified\": \"\",\n \"memberSize\": \"\",\n \"members\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n }\n ]\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: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups" + "events", + ":eventId" ], - "query": [ - { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", - "value": "" - }, - { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, - { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" + "description": "The unique identifier for the event.", + "key": "eventId" } - ], - "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" + ] } }, - "status": "OK" + "status": "Forbidden" }, { "_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": "GET", @@ -16666,62 +16467,27 @@ "{{baseUrl}}" ], "path": [ - "groups" + "events", + ":eventId" ], - "query": [ - { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", - "value": "" - }, - { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, - { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" + "description": "The unique identifier for the event.", + "key": "eventId" } - ], - "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" + ] } }, - "status": "Conflict" + "status": "Internal Server Error" }, { "_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", @@ -16730,62 +16496,27 @@ "{{baseUrl}}" ], "path": [ - "groups" + "events", + ":eventId" ], - "query": [ - { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", - "value": "" - }, - { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, - { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" + "description": "The unique identifier for the event.", + "key": "eventId" } - ], - "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" + ] } }, - "status": "Forbidden" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 502, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -16794,62 +16525,27 @@ "{{baseUrl}}" ], "path": [ - "groups" + "events", + ":eventId" ], - "query": [ - { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", - "value": "" - }, - { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, - { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" + "description": "The unique identifier for the event.", + "key": "eventId" } - ], - "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" + ] } }, - "status": "Service Unavailable" + "status": "Bad Gateway" }, { "_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", @@ -16858,59 +16554,242 @@ "{{baseUrl}}" ], "path": [ - "groups" + "events", + ":eventId" ], - "query": [ + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ { - "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, + "description": "The unique identifier for the event.", + "key": "eventId" + } + ] + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "events", + ":eventId" + ], + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ { - "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, + "description": "The unique identifier for the event.", + "key": "eventId" + } + ] + } + }, + "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": [ + "events", + ":eventId" + ], + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ { - "description": "Sort the results based by group `displayName`.", - "key": "sortBy", - "value": "" - }, + "description": "The unique identifier for the event.", + "key": "eventId" + } + ] + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "events", + ":eventId" + ], + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ { - "description": "Sort results alphabetically by group display name, in ascending or descending order.", - "key": "sortOrder", - "value": "" - }, + "description": "The unique identifier for the event.", + "key": "eventId" + } + ] + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "events", + ":eventId" + ], + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ { - "description": "Optionally return group members in the response. The maximum number of members returned is 500.", - "key": "includeMembers", - "value": "" - }, + "description": "The unique identifier for the event.", + "key": "eventId" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"resource\": \"tabs\",\n \"type\": \"created\",\n \"actorId\": \"\",\n \"orgId\": \"\",\n \"created\": \"\",\n \"data\": {\n \"id\": \"\",\n \"roomId\": \"\",\n \"roomType\": \"\",\n \"orgId\": \"\",\n \"text\": \"\",\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"meetingId\": \"\",\n \"creatorId\": \"\",\n \"host\": {},\n \"attendees\": [\n \"\",\n \"\"\n ],\n \"transcriptionEnabled\": \"\",\n \"recordingEnabled\": \"\",\n \"hasPostMeetingsChat\": \"\",\n \"corelationId\": \"\",\n \"callType\": \"\",\n \"userId\": \"\",\n \"userType\": \"\",\n \"callDirection\": \"\",\n \"isCallAnswered\": \"\",\n \"callDurationSeconds\": \"\",\n \"callStartTime\": \"\",\n \"callAnswerTime\": \"\",\n \"callTransferTime\": \"\",\n \"callingNumber\": \"\",\n \"callingLineId\": \"\",\n \"calledNumber\": \"\",\n \"calledLineId\": \"\",\n \"dialedDigits\": \"\",\n \"callRedirectingNumber\": \"\",\n \"callRedirectedReason\": \"\",\n \"created\": \"\",\n \"type\": \"\",\n \"breakoutSessionId\": \"\",\n \"recipients\": [\n {\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"guestDisplayName\": \"\",\n \"guestEmail\": \"\"\n },\n {\n \"personId\": \"\",\n \"personEmail\": \"\",\n \"guestDisplayName\": \"\",\n \"guestEmail\": \"\"\n }\n ]\n },\n \"appId\": \"\"\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": [ + "events", + ":eventId" + ], + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, + "description": "The unique identifier for the event.", + "key": "eventId" + } + ] + } + }, + "status": "OK" + }, + { + "_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": [ + "events", + ":eventId" + ], + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ { - "description": "Specifies the desired number of search results per page.", - "key": "count", - "value": "" + "description": "The unique identifier for the event.", + "key": "eventId" } + ] + } + }, + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" + "path": [ + "events", + ":eventId" + ], + "raw": "{{baseUrl}}/events/:eventId", + "variable": [ + { + "description": "The unique identifier for the event.", + "key": "eventId" + } + ] } }, - "status": "Method Not Allowed" + "status": "Precondition Required" } ] - }, + } + ], + "name": "Events" + }, + { + "item": [ { - "name": "Update a Group", + "name": "Create a Group", "request": { "body": { "mode": "raw", @@ -16920,9 +16799,9 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, - "description": "Update the group details, by ID.\n\nSpecify the group ID in the `groupId` parameter in the URI.", + "description": "Create a new group for a given organization. The group may optionally be created with group members.", "header": [ { "key": "Content-Type", @@ -16933,33 +16812,25 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId", - "value": "" - } - ] + "raw": "{{baseUrl}}/groups" } }, "response": [ { "_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": { "body": { "mode": "raw", @@ -16969,7 +16840,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, "header": [ { @@ -16977,33 +16848,26 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] + "raw": "{{baseUrl}}/groups" } }, - "status": "Too Many Requests" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 423, "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": "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", @@ -17013,7 +16877,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, "header": [ { @@ -17021,33 +16885,26 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] + "raw": "{{baseUrl}}/groups" } }, - "status": "Unsupported Media Type" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { "body": { "mode": "raw", @@ -17057,7 +16914,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, "header": [ { @@ -17065,33 +16922,26 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] + "raw": "{{baseUrl}}/groups" } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 415, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "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", @@ -17101,7 +16951,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, "header": [ { @@ -17109,33 +16959,26 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] + "raw": "{{baseUrl}}/groups" } }, - "status": "Gone" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 404, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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", @@ -17145,7 +16988,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, "header": [ { @@ -17153,33 +16996,26 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] + "raw": "{{baseUrl}}/groups" } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_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": { "body": { "mode": "raw", @@ -17189,7 +17025,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, "header": [ { @@ -17197,33 +17033,26 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] + "raw": "{{baseUrl}}/groups" } }, - "status": "Conflict" + "status": "Gone" }, { "_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", @@ -17233,7 +17062,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, "header": [ { @@ -17241,33 +17070,26 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] + "raw": "{{baseUrl}}/groups" } }, - "status": "Service Unavailable" + "status": "Bad Request" }, { "_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": { "body": { "mode": "raw", @@ -17277,7 +17099,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, "header": [ { @@ -17285,33 +17107,26 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] + "raw": "{{baseUrl}}/groups" } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_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", @@ -17321,7 +17136,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, "header": [ { @@ -17329,33 +17144,26 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] + "raw": "{{baseUrl}}/groups" } }, - "status": "Gateway Timeout" + "status": "Method Not Allowed" }, { "_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": { "body": { "mode": "raw", @@ -17365,7 +17173,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, "header": [ { @@ -17373,25 +17181,18 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] + "raw": "{{baseUrl}}/groups" } }, - "status": "Precondition Required" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -17409,7 +17210,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, "header": [ { @@ -17417,22 +17218,15 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] + "raw": "{{baseUrl}}/groups" } }, "status": "Bad Gateway" @@ -17440,10 +17234,10 @@ { "_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", @@ -17453,7 +17247,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, "header": [ { @@ -17461,33 +17255,26 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] + "raw": "{{baseUrl}}/groups" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "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", @@ -17497,7 +17284,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, "header": [ { @@ -17505,30 +17292,23 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] + "raw": "{{baseUrl}}/groups" } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"id\": \"\",\n \"displayName\": \"\",\n \"orgId\": \"\",\n \"created\": \"\",\n \"lastModified\": \"\",\n \"memberSize\": \"\",\n \"members\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n }\n ]\n}", - "code": 200, + "code": 201, "cookie": [], "header": [ { @@ -17536,7 +17316,7 @@ "value": "application/json" } ], - "name": "OK", + "name": "Created", "originalRequest": { "body": { "mode": "raw", @@ -17546,7 +17326,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, "header": [ { @@ -17558,33 +17338,26 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] + "raw": "{{baseUrl}}/groups" } }, - "status": "OK" + "status": "Created" }, { "_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", @@ -17594,7 +17367,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, "header": [ { @@ -17602,33 +17375,26 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] + "raw": "{{baseUrl}}/groups" } }, - "status": "Method Not Allowed" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 504, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -17638,7 +17404,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" }, "header": [ { @@ -17646,32 +17412,25 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], - "raw": "{{baseUrl}}/groups/:groupId", - "variable": [ - { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] + "raw": "{{baseUrl}}/groups" } }, - "status": "Bad Request" + "status": "Gateway Timeout" } ] }, { - "name": "Get Group Details", + "name": "List and Search Groups", "request": { - "description": "Get details for a group, by ID.\n\nOptionally, the members may be retrieved with this request. The maximum number of members returned is 500.", + "description": "List groups in your organization.\n\n* Set the `includeMembers` parameter to `true` to return group members. The total number of members returned is limited to 500.\n\n* Use the `startIndex` and `count` parameters to page through result set.\n\n* To search for a specific group use the `filter` parameter.\n\n* Use `sortBy` parameter to sort the responses by `id` or `displayName`.", "header": [ { "key": "Accept", @@ -17684,34 +17443,61 @@ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", - "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId", + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", + "key": "includeMembers", + "value": "" + }, + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 423, "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": "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", @@ -17720,80 +17506,126 @@ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", + "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, - "status": "Too Many Requests" + "status": "Locked (WebDAV) (RFC 4918)" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"displayName\": \"\",\n \"orgId\": \"\",\n \"created\": \"\",\n \"lastModified\": \"\",\n \"memberSize\": \"\",\n \"members\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 429, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", + "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 410, "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": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -17802,34 +17634,62 @@ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", + "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, - "status": "Internal Server Error" + "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": "GET", @@ -17838,34 +17698,62 @@ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", + "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, - "status": "Method Not Allowed" + "status": "Bad Request" }, { "_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", @@ -17874,26 +17762,54 @@ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", + "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -17910,23 +17826,51 @@ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", + "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, "status": "Unauthorized" @@ -17934,10 +17878,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", @@ -17946,34 +17890,62 @@ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", + "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, - "status": "Conflict" + "status": "Precondition Required" }, { "_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", @@ -17982,34 +17954,62 @@ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", - "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", + "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", + "key": "includeMembers", + "value": "" + }, + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, - "status": "Service Unavailable" + "status": "Not Found" }, { "_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", @@ -18018,26 +18018,54 @@ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", + "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -18054,23 +18082,51 @@ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", + "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, "status": "Unsupported Media Type" @@ -18078,10 +18134,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 502, "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 Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -18090,70 +18146,136 @@ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", + "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, - "status": "Gateway Timeout" + "status": "Bad Gateway" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 502, + "_postman_previewlanguage": "json", + "body": "{\n \"totalResults\": \"\",\n \"startIndex\": \"\",\n \"itemsPerPage\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"orgId\": \"\",\n \"created\": \"\",\n \"lastModified\": \"\",\n \"memberSize\": \"\",\n \"members\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"orgId\": \"\",\n \"created\": \"\",\n \"lastModified\": \"\",\n \"memberSize\": \"\",\n \"members\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n }\n ]\n }\n ]\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": [ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", + "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, - "status": "Bad Gateway" + "status": "OK" }, { "_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", @@ -18162,34 +18284,62 @@ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", + "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, - "status": "Gone" + "status": "Conflict" }, { "_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", @@ -18198,34 +18348,62 @@ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", + "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, - "status": "Not Found" + "status": "Forbidden" }, { "_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", @@ -18234,34 +18412,62 @@ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", + "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, - "status": "Precondition Required" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 405, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -18270,38 +18476,85 @@ "{{baseUrl}}" ], "path": [ - "groups", - ":groupId" + "groups" ], "query": [ { - "description": "Include the members as part of the response.", + "description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Sort the results based by group `displayName`.", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort results alphabetically by group display name, in ascending or descending order.", + "key": "sortOrder", + "value": "" + }, + { + "description": "Optionally return group members in the response. The maximum number of members returned is 500.", "key": "includeMembers", - "value": "false" - } - ], - "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", - "variable": [ + "value": "" + }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Specifies the desired number of search results per page.", + "key": "count", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/groups?orgId=&filter=&attributes=&sortBy=&sortOrder=&includeMembers=&startIndex=&count=" } }, - "status": "Bad Request" + "status": "Method Not Allowed" } ] }, { - "name": "Delete a Group", + "name": "Update a Group", "request": { - "description": "Remove a group from the system.\n\nSpecify the group ID in the `groupId` parameter in the URI.", - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "description": "Update the group details, by ID.\n\nSpecify the group ID in the `groupId` parameter in the URI.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" ], "path": [ "groups", @@ -18321,13 +18574,28 @@ { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -18345,18 +18613,33 @@ ] } }, - "status": "Unsupported Media Type" + "status": "Too Many Requests" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -18374,18 +18657,33 @@ ] } }, - "status": "Internal Server Error" + "status": "Unsupported Media Type" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -18403,18 +18701,33 @@ ] } }, - "status": "Service Unavailable" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 410, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -18432,18 +18745,33 @@ ] } }, - "status": "Bad Gateway" + "status": "Gone" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -18461,18 +18789,33 @@ ] } }, - "status": "Gateway Timeout" + "status": "Unauthorized" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -18490,18 +18833,33 @@ ] } }, - "status": "Method Not Allowed" + "status": "Conflict" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -18519,7 +18877,7 @@ ] } }, - "status": "Not Found" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", @@ -18529,8 +18887,23 @@ "header": [], "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -18553,13 +18926,28 @@ { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -18577,18 +18965,33 @@ ] } }, - "status": "Too Many Requests" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 428, "cookie": [], "header": [], - "name": "No Content", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -18606,18 +19009,33 @@ ] } }, - "status": "No Content" + "status": "Precondition Required" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -18635,18 +19053,33 @@ ] } }, - "status": "Gone" + "status": "Bad Gateway" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -18664,18 +19097,33 @@ ] } }, - "status": "Conflict" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -18693,18 +19141,42 @@ ] } }, - "status": "Precondition Required" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"displayName\": \"\",\n \"orgId\": \"\",\n \"created\": \"\",\n \"lastModified\": \"\",\n \"memberSize\": \"\",\n \"members\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -18722,18 +19194,33 @@ ] } }, - "status": "Unauthorized" + "status": "OK" }, { "_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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -18751,7 +19238,7 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", @@ -18761,8 +19248,23 @@ "header": [], "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -18785,9 +19287,9 @@ ] }, { - "name": "Get Group Members", + "name": "Get Group Details", "request": { - "description": "Gets the members of a group.\n\n* The default maximum members returned is 500.\n\n* Control parameters is available to page through the members and to control the size of the results.", + "description": "Get details for a group, by ID.\n\nOptionally, the members may be retrieved with this request. The maximum number of members returned is 500.", "header": [ { "key": "Accept", @@ -18801,22 +19303,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -18843,22 +19339,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -18895,22 +19385,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -18924,10 +19408,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 500, "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": "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", @@ -18937,22 +19421,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -18961,15 +19439,15 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Internal Server Error" }, { "_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", @@ -18979,22 +19457,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -19003,15 +19475,15 @@ ] } }, - "status": "Unsupported Media Type" + "status": "Method Not Allowed" }, { "_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": { "header": [], "method": "GET", @@ -19021,22 +19493,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -19045,15 +19511,15 @@ ] } }, - "status": "Method Not Allowed" + "status": "Forbidden" }, { "_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", @@ -19063,22 +19529,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -19087,15 +19547,15 @@ ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_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": "GET", @@ -19105,22 +19565,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -19129,15 +19583,15 @@ ] } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 503, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -19147,22 +19601,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -19171,15 +19619,15 @@ ] } }, - "status": "Unauthorized" + "status": "Service Unavailable" }, { "_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": "GET", @@ -19189,22 +19637,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -19213,15 +19655,15 @@ ] } }, - "status": "Service Unavailable" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", @@ -19231,22 +19673,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -19255,15 +19691,15 @@ ] } }, - "status": "Gateway Timeout" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 504, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -19273,22 +19709,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -19297,7 +19727,7 @@ ] } }, - "status": "Bad Request" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -19315,22 +19745,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -19344,10 +19768,10 @@ { "_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", @@ -19357,22 +19781,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -19381,15 +19799,15 @@ ] } }, - "status": "Conflict" + "status": "Gone" }, { "_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": { "header": [], "method": "GET", @@ -19399,22 +19817,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -19423,15 +19835,15 @@ ] } }, - "status": "Forbidden" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 428, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -19441,22 +19853,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -19465,15 +19871,15 @@ ] } }, - "status": "Gone" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 400, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], "method": "GET", @@ -19483,22 +19889,16 @@ ], "path": [ "groups", - ":groupId", - "members" + ":groupId" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" - }, - { - "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Include the members as part of the response.", + "key": "includeMembers", + "value": "false" } ], - "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "raw": "{{baseUrl}}/groups/:groupId?includeMembers=false", "variable": [ { "description": "A unique identifier for the group.", @@ -19507,89 +19907,63 @@ ] } }, - "status": "Precondition Required" + "status": "Bad Request" } ] - } - ], - "name": "Groups" - }, - { - "item": [ + }, { - "name": "Create a Guest", + "name": "Delete a Group", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "description": "Create a new token for a single guest user. The Service App that creates the guest must have the scope `guest-issuer:write`.\n\nGuests are implicitly created by retrieving the guest access token.\n\nRepeated calls to this API with the same `subject` will create additional tokens without invalidating previous ones. Tokens are valid until the `expiresIn`.\n\nGuests can be renamed by supplying the same `subject` and changing the `displayName.`\n\nTo retrieve a new token for an existing guest, please provide the existing guest's `subject`. Tokens are valid until `expiresIn`.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "description": "Remove a group from the system.\n\nSpecify the group ID in the `groupId` parameter in the URI.", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId", + "value": "" + } + ] } }, "response": [ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Method Not Allowed" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", @@ -19599,32 +19973,23 @@ "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 \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, "status": "Internal Server Error" @@ -19632,315 +19997,234 @@ { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Forbidden" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"subject\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"accessToken\": \"\",\n \"expiresIn\": \"\"\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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "OK" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 504, "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": "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 \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Not Found" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 405, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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 \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Bad Request" + "status": "Method Not Allowed" }, { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Unsupported Media Type" + "status": "Not Found" }, { "_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 \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Conflict" + "status": "Forbidden" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Service Unavailable" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 204, "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": "No Content", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Gateway Timeout" + "status": "No Content" }, { "_postman_previewlanguage": "text", @@ -19950,32 +20234,23 @@ "header": [], "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, "status": "Gone" @@ -19983,78 +20258,60 @@ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 428, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "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 \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Bad Gateway" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", @@ -20064,32 +20321,23 @@ "header": [], "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, "status": "Unauthorized" @@ -20097,89 +20345,71 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 423, "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": "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 \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Too Many Requests" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 400, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "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 \"subject\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "guests", - "token" + "groups", + ":groupId" ], - "raw": "{{baseUrl}}/guests/token" + "raw": "{{baseUrl}}/groups/:groupId", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Precondition Required" + "status": "Bad Request" } ] }, { - "name": "Get Guest Count", + "name": "Get Group Members", "request": { - "description": "To retrieve the number of guests, the scopes `guest-issuer:read` or `guest-issuer:write` are needed.", + "description": "Gets the members of a group.\n\n* The default maximum members returned is 500.\n\n* Control parameters is available to page through the members and to control the size of the results.", "header": [ { "key": "Accept", - "value": "text/plain" + "value": "application/json" } ], "method": "GET", @@ -20188,20 +20418,40 @@ "{{baseUrl}}" ], "path": [ - "guests", - "count" + "groups", + ":groupId", + "members" ], - "raw": "{{baseUrl}}/guests/count" + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" + } + ], + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId", + "value": "" + } + ] } }, "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", @@ -20210,23 +20460,42 @@ "{{baseUrl}}" ], "path": [ - "guests", - "count" + "groups", + ":groupId", + "members" ], - "raw": "{{baseUrl}}/guests/count" + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" + } + ], + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"112\": \"\"\n}", + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"displayName\": \"\",\n \"orgId\": \"\",\n \"created\": \"\",\n \"lastModified\": \"\",\n \"memberSize\": \"\",\n \"members\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"displayName\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "text/plain" + "value": "application/json" } ], "name": "OK", @@ -20234,7 +20503,7 @@ "header": [ { "key": "Accept", - "value": "text/plain" + "value": "application/json" } ], "method": "GET", @@ -20243,10 +20512,29 @@ "{{baseUrl}}" ], "path": [ - "guests", - "count" + "groups", + ":groupId", + "members" ], - "raw": "{{baseUrl}}/guests/count" + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" + } + ], + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, "status": "OK" @@ -20254,10 +20542,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 423, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -20266,36 +20554,32 @@ "{{baseUrl}}" ], "path": [ - "guests", - "count" + "groups", + ":groupId", + "members" ], - "raw": "{{baseUrl}}/guests/count" - } - }, - "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": [ - "guests", - "count" + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" + } ], - "raw": "{{baseUrl}}/guests/count" + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Gateway Timeout" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", @@ -20312,10 +20596,29 @@ "{{baseUrl}}" ], "path": [ - "guests", - "count" + "groups", + ":groupId", + "members" ], - "raw": "{{baseUrl}}/guests/count" + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" + } + ], + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, "status": "Unsupported Media Type" @@ -20323,10 +20626,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 405, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -20335,44 +20638,40 @@ "{{baseUrl}}" ], "path": [ - "guests", - "count" - ], - "raw": "{{baseUrl}}/guests/count" - } - }, - "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": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" + "groups", + ":groupId", + "members" ], - "path": [ - "guests", - "count" + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" + } ], - "raw": "{{baseUrl}}/guests/count" + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Conflict" + "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", @@ -20381,44 +20680,40 @@ "{{baseUrl}}" ], "path": [ - "guests", - "count" - ], - "raw": "{{baseUrl}}/guests/count" - } - }, - "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}}" + "groups", + ":groupId", + "members" ], - "path": [ - "guests", - "count" + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" + } ], - "raw": "{{baseUrl}}/guests/count" + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Forbidden" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 500, "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": "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", @@ -20427,21 +20722,40 @@ "{{baseUrl}}" ], "path": [ - "guests", - "count" + "groups", + ":groupId", + "members" ], - "raw": "{{baseUrl}}/guests/count" + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" + } + ], + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 401, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], "method": "GET", @@ -20450,21 +20764,40 @@ "{{baseUrl}}" ], "path": [ - "guests", - "count" + "groups", + ":groupId", + "members" ], - "raw": "{{baseUrl}}/guests/count" + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" + } + ], + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Bad Gateway" + "status": "Unauthorized" }, { "_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", @@ -20473,21 +20806,40 @@ "{{baseUrl}}" ], "path": [ - "guests", - "count" + "groups", + ":groupId", + "members" ], - "raw": "{{baseUrl}}/guests/count" + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" + } + ], + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Method Not Allowed" + "status": "Service Unavailable" }, { "_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", @@ -20496,21 +20848,40 @@ "{{baseUrl}}" ], "path": [ - "guests", - "count" + "groups", + ":groupId", + "members" ], - "raw": "{{baseUrl}}/guests/count" + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" + } + ], + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Precondition Required" + "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": { "header": [], "method": "GET", @@ -20519,21 +20890,40 @@ "{{baseUrl}}" ], "path": [ - "guests", - "count" + "groups", + ":groupId", + "members" ], - "raw": "{{baseUrl}}/guests/count" + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" + } + ], + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 502, "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": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -20542,21 +20932,40 @@ "{{baseUrl}}" ], "path": [ - "guests", - "count" + "groups", + ":groupId", + "members" ], - "raw": "{{baseUrl}}/guests/count" + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" + } + ], + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Too Many Requests" + "status": "Bad Gateway" }, { "_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", @@ -20565,58 +20974,33 @@ "{{baseUrl}}" ], "path": [ - "guests", - "count" + "groups", + ":groupId", + "members" ], - "raw": "{{baseUrl}}/guests/count" + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" + } + ], + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Gone" - } - ] - } - ], - "name": "Guest Management" - }, - { - "item": [ - { - "name": "Historical Data related to Messaging", - "request": { - "description": "Returns daily aggregates of various metrics related to Webex messaging.\n\n
The base URL for these APIs is **analytics.webexapis.com**, which does not work with the **Try It** feature.
", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." - } - ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." - } - }, - "response": [ + "status": "Conflict" + }, { "_postman_previewlanguage": "text", "body": null, @@ -20632,24 +21016,29 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" + "groups", + ":groupId", + "members" ], "query": [ { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" }, { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" } ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, "status": "Forbidden" @@ -20657,10 +21046,10 @@ { "_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", @@ -20669,27 +21058,32 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" + "groups", + ":groupId", + "members" ], "query": [ { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" }, { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" } ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, - "status": "Unauthorized" + "status": "Gone" }, { "_postman_previewlanguage": "text", @@ -20706,68 +21100,194 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" + "groups", + ":groupId", + "members" ], "query": [ { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" }, { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.", + "key": "count", + "value": "" } ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "raw": "{{baseUrl}}/groups/:groupId/members?startIndex=&count=", + "variable": [ + { + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] } }, "status": "Precondition Required" - }, - { - "_postman_previewlanguage": "text", + } + ] + } + ], + "name": "Groups" + }, + { + "item": [ + { + "name": "Create a Guest", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, + "description": "Create a new token for a single guest user. The Service App that creates the guest must have the scope `guest-issuer:write`.\n\nGuests are implicitly created by retrieving the guest access token.\n\nRepeated calls to this API with the same `subject` will create additional tokens without invalidating previous ones. Tokens are valid until the `expiresIn`.\n\nGuests can be renamed by supplying the same `subject` and changing the `displayName.`\n\nTo retrieve a new token for an existing guest, please provide the existing guest's `subject`. Tokens are valid until `expiresIn`.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "guests", + "token" + ], + "raw": "{{baseUrl}}/guests/token" + } + }, + "response": [ + { + "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" + "guests", + "token" ], - "query": [ - { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "raw": "{{baseUrl}}/guests/token" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } + }, + "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "path": [ + "guests", + "token" + ], + "raw": "{{baseUrl}}/guests/token" } }, - "status": "Conflict" + "status": "Internal Server Error" + }, + { + "_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 \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "guests", + "token" + ], + "raw": "{{baseUrl}}/guests/token" + } + }, + "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"metrics\": {\n \"dates\": \"\",\n \"dailyActiveUsers\": \"\",\n \"totalMessagesSent\": \"\",\n \"deskTopMessagesSent\": \"\",\n \"mobileMessagesSent\": \"\",\n \"totalActiveSpaces\": \"\",\n \"groupActiveSpaces\": \"\",\n \"one2oneActiveSpaces\": \"\",\n \"video\": \"\",\n \"sharing\": {\n \"totalFilesShared\": \"\",\n \"fileShareSize\": \"\"\n },\n \"recording\": \"\",\n \"audio\": \"\"\n }\n}", + "body": "{\n \"id\": \"\",\n \"subject\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"accessToken\": \"\",\n \"expiresIn\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -20778,36 +21298,36 @@ ], "name": "OK", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." - } + "guests", + "token" ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "raw": "{{baseUrl}}/guests/token" } }, "status": "OK" @@ -20820,31 +21340,32 @@ "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." - } + "guests", + "token" ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "raw": "{{baseUrl}}/guests/token" } }, "status": "Not Found" @@ -20852,383 +21373,431 @@ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." - } + "guests", + "token" ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "raw": "{{baseUrl}}/guests/token" } }, - "status": "Gateway Timeout" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 415, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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 \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." - } + "guests", + "token" ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "raw": "{{baseUrl}}/guests/token" } }, - "status": "Bad Request" + "status": "Unsupported Media Type" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." - } + "guests", + "token" ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "raw": "{{baseUrl}}/guests/token" } }, - "status": "Method Not Allowed" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 503, "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": "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 \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." - } + "guests", + "token" ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "raw": "{{baseUrl}}/guests/token" } }, - "status": "Internal Server Error" + "status": "Service Unavailable" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." - } + "guests", + "token" ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "raw": "{{baseUrl}}/guests/token" } }, - "status": "Too Many Requests" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 410, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." - } + "guests", + "token" ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "raw": "{{baseUrl}}/guests/token" } }, - "status": "Bad Gateway" + "status": "Gone" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." - } + "guests", + "token" ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "raw": "{{baseUrl}}/guests/token" } }, - "status": "Gone" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 502, "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 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 \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." - } + "guests", + "token" ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "raw": "{{baseUrl}}/guests/token" } }, - "status": "Unsupported Media Type" + "status": "Bad Gateway" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." - } + "guests", + "token" ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "raw": "{{baseUrl}}/guests/token" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unauthorized" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "messagingMetrics", - "dailyTotals" + "guests", + "token" ], - "query": [ - { - "description": "UTC date starting from which the data needs to be returned.", - "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "UTC date up to which the data needs to be returned", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "raw": "{{baseUrl}}/guests/token" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } + }, + "raw": "{\n \"subject\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." + "path": [ + "guests", + "token" + ], + "raw": "{{baseUrl}}/guests/token" } }, - "status": "Service Unavailable" + "status": "Precondition Required" } ] }, { - "name": "Historical Data related to Room Devices", + "name": "Get Guest Count", "request": { - "description": "Returns daily aggregates of various metrics related to Room Devices.\n\n
The base URL for these APIs is **analytics.webexapis.com**, which does not work with the **Try It** feature.
", + "description": "To retrieve the number of guests, the scopes `guest-issuer:read` or `guest-issuer:write` are needed.", "header": [ { "key": "Accept", - "value": "application/json" + "value": "text/plain" } ], "method": "GET", @@ -21237,34 +21806,20 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } + "guests", + "count" ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + "raw": "{{baseUrl}}/guests/count" } }, "response": [ { "_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", @@ -21273,74 +21828,23 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } + "guests", + "count" ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + "raw": "{{baseUrl}}/guests/count" } }, - "status": "Not Found" + "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": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } - ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } - }, - "status": "Gone" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"metrics\": {\n \"dates\": \"\",\n \"totalActiveDevices\": \"\",\n \"totalAssistantCommands\": \"\",\n \"totalUsageHours\": \"\",\n \"incallUsageDuration\": \"\",\n \"signageUsageDuration\": \"\",\n \"usbpassthroughUsageDuration\": \"\",\n \"whiteboardingUsageDuration\": \"\",\n \"video\": \"\",\n \"sharing\": {\n \"localsharingcableUsageDuration\": \"\",\n \"localsharingwirelessUsageDuration\": \"\"\n },\n \"recording\": \"\",\n \"audio\": \"\"\n }\n}", + "body": "{\n \"112\": \"\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "text/plain" } ], "name": "OK", @@ -21348,7 +21852,7 @@ "header": [ { "key": "Accept", - "value": "application/json" + "value": "text/plain" } ], "method": "GET", @@ -21357,24 +21861,10 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } + "guests", + "count" ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + "raw": "{{baseUrl}}/guests/count" } }, "status": "OK" @@ -21382,10 +21872,10 @@ { "_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": { "header": [], "method": "GET", @@ -21394,35 +21884,21 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } + "guests", + "count" ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + "raw": "{{baseUrl}}/guests/count" } }, - "status": "Unsupported Media Type" + "status": "Bad Request" }, { "_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", @@ -21431,35 +21907,21 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } + "guests", + "count" ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + "raw": "{{baseUrl}}/guests/count" } }, - "status": "Bad Gateway" + "status": "Gateway Timeout" }, { "_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", @@ -21468,35 +21930,21 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } + "guests", + "count" ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + "raw": "{{baseUrl}}/guests/count" } }, - "status": "Too Many Requests" + "status": "Unsupported Media Type" }, { "_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", @@ -21505,35 +21953,21 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } + "guests", + "count" ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + "raw": "{{baseUrl}}/guests/count" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unauthorized" }, { "_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": "GET", @@ -21542,35 +21976,21 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } + "guests", + "count" ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + "raw": "{{baseUrl}}/guests/count" } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_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", @@ -21579,35 +21999,21 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } + "guests", + "count" ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + "raw": "{{baseUrl}}/guests/count" } }, - "status": "Gateway Timeout" + "status": "Service Unavailable" }, { "_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", @@ -21616,35 +22022,21 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } + "guests", + "count" ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + "raw": "{{baseUrl}}/guests/count" } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 404, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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", @@ -21653,35 +22045,21 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } + "guests", + "count" ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + "raw": "{{baseUrl}}/guests/count" } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 502, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -21690,35 +22068,21 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } + "guests", + "count" ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + "raw": "{{baseUrl}}/guests/count" } }, - "status": "Service Unavailable" + "status": "Bad Gateway" }, { "_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", @@ -21727,27 +22091,13 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } + "guests", + "count" ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + "raw": "{{baseUrl}}/guests/count" } }, - "status": "Conflict" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", @@ -21764,24 +22114,10 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } + "guests", + "count" ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + "raw": "{{baseUrl}}/guests/count" } }, "status": "Precondition Required" @@ -21789,10 +22125,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", @@ -21801,35 +22137,21 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" - ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } + "guests", + "count" ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + "raw": "{{baseUrl}}/guests/count" } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_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", @@ -21838,34 +22160,48 @@ "{{baseUrl}}" ], "path": [ - "v1", - "analytics", - "roomDeviceMetrics", - "dailyTotals" + "guests", + "count" ], - "query": [ - { - "description": "Starting UTC Date from which historical data should be returned.", - "key": "from", - "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." - }, - { - "description": "Ending UTC Date for which data should be returned.", - "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." - } + "raw": "{{baseUrl}}/guests/count" + } + }, + "status": "Too Many Requests" + }, + { + "_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}}" ], - "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + "path": [ + "guests", + "count" + ], + "raw": "{{baseUrl}}/guests/count" } }, - "status": "Method Not Allowed" + "status": "Gone" } ] - }, + } + ], + "name": "Guest Management" + }, + { + "item": [ { - "name": "Historical Data related to Meetings", + "name": "Historical Data related to Messaging", "request": { - "description": "Return aggregates of various metrics related to meetings for a given Webex site over a specified time range.\n\n
The base URL for these APIs is **analytics.webexapis.com**, which does not work with the **Try It** feature.
", + "description": "Returns daily aggregates of various metrics related to Webex messaging.\n\n
The base URL for these APIs is **analytics.webexapis.com**, which does not work with the **Try It** feature.
", "header": [ { "key": "Accept", @@ -21880,37 +22216,32 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, "response": [ { "_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", @@ -21921,38 +22252,33 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, - "status": "Gone" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 401, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], "method": "GET", @@ -21963,38 +22289,33 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, - "status": "Method Not Allowed" + "status": "Unauthorized" }, { "_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", @@ -22005,38 +22326,33 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, - "status": "Unsupported Media Type" + "status": "Precondition Required" }, { "_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", @@ -22047,40 +22363,45 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, - "status": "Unauthorized" + "status": "Conflict" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 504, + "_postman_previewlanguage": "json", + "body": "{\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"metrics\": {\n \"dates\": \"\",\n \"dailyActiveUsers\": \"\",\n \"totalMessagesSent\": \"\",\n \"deskTopMessagesSent\": \"\",\n \"mobileMessagesSent\": \"\",\n \"totalActiveSpaces\": \"\",\n \"groupActiveSpaces\": \"\",\n \"one2oneActiveSpaces\": \"\",\n \"video\": \"\",\n \"sharing\": {\n \"totalFilesShared\": \"\",\n \"fileShareSize\": \"\"\n },\n \"recording\": \"\",\n \"audio\": \"\"\n }\n}", + "code": 200, "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": "OK", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ @@ -22089,38 +22410,33 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, - "status": "Gateway Timeout" + "status": "OK" }, { "_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", @@ -22131,38 +22447,33 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, - "status": "Service Unavailable" + "status": "Not Found" }, { "_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", @@ -22173,38 +22484,33 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, - "status": "Internal Server Error" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 400, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], "method": "GET", @@ -22215,38 +22521,33 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, - "status": "Precondition Required" + "status": "Bad Request" }, { "_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", @@ -22257,38 +22558,33 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, - "status": "Forbidden" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 500, "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": "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", @@ -22299,38 +22595,33 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Internal Server Error" }, { "_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": { "header": [], "method": "GET", @@ -22341,38 +22632,33 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 502, "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": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -22383,50 +22669,35 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, - "status": "Too Many Requests" + "status": "Bad Gateway" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"siteUrl\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"metrics\": {\n \"totalMeetings\": \"\",\n \"totalParticipants\": \"\",\n \"totalUniqueHosts\": \"\",\n \"totalMeetingMinutes\": \"\",\n \"totalAudioMinutes\": \"\",\n \"totalTelephoneMinutes\": \"\",\n \"totalVoIPMinutes\": \"\",\n \"videoMeetings\": \"\",\n \"sharingMeetings\": \"\",\n \"recordingMeetings\": \"\",\n \"participantsByJoinMethods\": {\n \"webApp\": \"\",\n \"cloudVideoDevice\": \"\",\n \"mobileMeetingsApp\": \"\"\n },\n \"participantsByRoles\": {\n \"host\": \"\",\n \"attendee\": \"\"\n },\n \"participantsByLocation\": [\n {\n \"country\": \"\",\n \"totalParticipants\": \"\"\n },\n {\n \"country\": \"\",\n \"totalParticipants\": \"\"\n }\n ]\n }\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 410, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -22435,38 +22706,33 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, - "status": "OK" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 415, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -22477,38 +22743,33 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, - "status": "Bad Request" + "status": "Unsupported Media Type" }, { "_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": { "header": [], "method": "GET", @@ -22519,38 +22780,33 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, - "status": "Conflict" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { "header": [], "method": "GET", @@ -22561,42 +22817,32 @@ "path": [ "v1", "analytics", - "meetingsMetrics", - "aggregates" + "messagingMetrics", + "dailyTotals" ], "query": [ { - "description": "URL of the Webex site for which historical data is requested.", - "key": "siteUrl", - "value": "" - }, - { - "description": "UTC Date starting from which the data needs to be returned", + "description": "UTC date starting from which the data needs to be returned.", "key": "from", - "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." }, { - "description": "UTC Date up to which the data needs to be returned", + "description": "UTC date up to which the data needs to be returned", "key": "to", - "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } ], - "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + "raw": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals?from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned." } }, - "status": "Bad Gateway" + "status": "Service Unavailable" } ] - } - ], - "name": "Historical Analytics APIs" - }, - { - "item": [ + }, { - "name": "List Hybrid Clusters", + "name": "Historical Data related to Room Devices", "request": { - "description": "List hybrid clusters for an organization. If no `orgId` is specified, the default is the organization of the authenticated user.\n\nOnly an admin auth token with the `spark-admin:hybrid_clusters_read` scope can list clusters.", + "description": "Returns daily aggregates of various metrics related to Room Devices.\n\n
The base URL for these APIs is **analytics.webexapis.com**, which does not work with the **Try It** feature.
", "header": [ { "key": "Accept", @@ -22609,57 +22855,34 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, + { + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } ], - "raw": "{{baseUrl}}/hybrid/clusters?orgId=" + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, "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": [ - "hybrid", - "clusters" - ], - "query": [ - { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters?orgId=" - } - }, - "status": "Conflict" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "code": 404, "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": "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", @@ -22668,58 +22891,35 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters?orgId=" - } - }, - "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": [ - "hybrid", - "clusters" - ], - "query": [ + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } ], - "raw": "{{baseUrl}}/hybrid/clusters?orgId=" + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 410, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -22728,54 +22928,31 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters?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": [ - "hybrid", - "clusters" - ], - "query": [ + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } ], - "raw": "{{baseUrl}}/hybrid/clusters?orgId=" + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, - "status": "Too Many Requests" + "status": "Gone" }, { "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"orgId\": \"\",\n \"name\": \"\",\n \"resourceGroupId\": \"\"\n },\n {\n \"id\": \"\",\n \"orgId\": \"\",\n \"name\": \"\",\n \"resourceGroupId\": \"\"\n }\n ]\n}", + "body": "{\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"metrics\": {\n \"dates\": \"\",\n \"totalActiveDevices\": \"\",\n \"totalAssistantCommands\": \"\",\n \"totalUsageHours\": \"\",\n \"incallUsageDuration\": \"\",\n \"signageUsageDuration\": \"\",\n \"usbpassthroughUsageDuration\": \"\",\n \"whiteboardingUsageDuration\": \"\",\n \"video\": \"\",\n \"sharing\": {\n \"localsharingcableUsageDuration\": \"\",\n \"localsharingwirelessUsageDuration\": \"\"\n },\n \"recording\": \"\",\n \"audio\": \"\"\n }\n}", "code": 200, "cookie": [], "header": [ @@ -22798,17 +22975,24 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, + { + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } ], - "raw": "{{baseUrl}}/hybrid/clusters?orgId=" + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, "status": "OK" @@ -22828,17 +23012,24 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, + { + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } ], - "raw": "{{baseUrl}}/hybrid/clusters?orgId=" + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, "status": "Unsupported Media Type" @@ -22846,10 +23037,10 @@ { "_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": "GET", @@ -22858,28 +23049,35 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, + { + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } ], - "raw": "{{baseUrl}}/hybrid/clusters?orgId=" + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, - "status": "Not Found" + "status": "Bad Gateway" }, { "_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", @@ -22888,28 +23086,35 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, + { + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } ], - "raw": "{{baseUrl}}/hybrid/clusters?orgId=" + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, - "status": "Precondition Required" + "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": "GET", @@ -22918,28 +23123,35 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, + { + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } ], - "raw": "{{baseUrl}}/hybrid/clusters?orgId=" + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, - "status": "Service Unavailable" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { "header": [], "method": "GET", @@ -22948,20 +23160,27 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, + { + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } ], - "raw": "{{baseUrl}}/hybrid/clusters?orgId=" + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, - "status": "Bad Gateway" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -22978,17 +23197,24 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, + { + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } ], - "raw": "{{baseUrl}}/hybrid/clusters?orgId=" + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, "status": "Gateway Timeout" @@ -22996,10 +23222,10 @@ { "_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": "GET", @@ -23008,28 +23234,35 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, + { + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } ], - "raw": "{{baseUrl}}/hybrid/clusters?orgId=" + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, - "status": "Method Not Allowed" + "status": "Bad Request" }, { "_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", @@ -23038,28 +23271,35 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, + { + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } ], - "raw": "{{baseUrl}}/hybrid/clusters?orgId=" + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unauthorized" }, { "_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", @@ -23068,28 +23308,35 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" - } + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, + { + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." + } ], - "raw": "{{baseUrl}}/hybrid/clusters?orgId=" + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, - "status": "Gone" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 409, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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", @@ -23098,68 +23345,35 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, + { + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } ], - "raw": "{{baseUrl}}/hybrid/clusters?orgId=" + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, - "status": "Forbidden" - } - ] - }, - { - "name": "Get Hybrid Cluster Details", - "request": { - "description": "Shows details for a hybrid cluster, by ID.\n\nOnly an admin auth token with the `spark-admin:hybrid_clusters_read` scope can see cluster details.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "hybrid", - "clusters", - ":hybridClusterId" - ], - "query": [ - { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ - { - "description": "The ID of the cluster.", - "key": "hybridClusterId", - "value": "" - } - ] - } - }, - "response": [ + "status": "Conflict" + }, { "_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": { "header": [], "method": "GET", @@ -23168,35 +23382,35 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters", - ":hybridClusterId" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, { - "description": "The ID of the cluster.", - "key": "hybridClusterId" + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, - "status": "Not Found" + "status": "Precondition Required" }, { "_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", @@ -23205,35 +23419,35 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters", - ":hybridClusterId" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, { - "description": "The ID of the cluster.", - "key": "hybridClusterId" + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, - "status": "Gateway Timeout" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 405, "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": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -23242,35 +23456,79 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters", - ":hybridClusterId" + "v1", + "analytics", + "roomDeviceMetrics", + "dailyTotals" ], "query": [ { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ + "description": "Starting UTC Date from which historical data should be returned.", + "key": "from", + "value": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned." + }, { - "description": "The ID of the cluster.", - "key": "hybridClusterId" + "description": "Ending UTC Date for which data should be returned.", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals?from=Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain." } }, - "status": "Too Many Requests" - }, + "status": "Method Not Allowed" + } + ] + }, + { + "name": "Historical Data related to Meetings", + "request": { + "description": "Return aggregates of various metrics related to meetings for a given Webex site over a specified time range.\n\n
The base URL for these APIs is **analytics.webexapis.com**, which does not work with the **Try It** feature.
", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "analytics", + "meetingsMetrics", + "aggregates" + ], + "query": [ + { + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", + "value": "" + }, + { + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + } + ], + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + } + }, + "response": [ { "_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", @@ -23279,27 +23537,32 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters", - ":hybridClusterId" + "v1", + "analytics", + "meetingsMetrics", + "aggregates" ], "query": [ { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ + }, { - "description": "The ID of the cluster.", - "key": "hybridClusterId" + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } }, - "status": "Precondition Required" + "status": "Gone" }, { "_postman_previewlanguage": "text", @@ -23316,24 +23579,29 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters", - ":hybridClusterId" + "v1", + "analytics", + "meetingsMetrics", + "aggregates" ], "query": [ { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ + }, { - "description": "The ID of the cluster.", - "key": "hybridClusterId" + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } }, "status": "Method Not Allowed" @@ -23341,10 +23609,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 415, "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": "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", @@ -23353,35 +23621,40 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters", - ":hybridClusterId" + "v1", + "analytics", + "meetingsMetrics", + "aggregates" ], "query": [ { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ + }, { - "description": "The ID of the cluster.", - "key": "hybridClusterId" + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unsupported Media Type" }, { "_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": "GET", @@ -23390,35 +23663,40 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters", - ":hybridClusterId" + "v1", + "analytics", + "meetingsMetrics", + "aggregates" ], "query": [ { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ + }, { - "description": "The ID of the cluster.", - "key": "hybridClusterId" + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } }, - "status": "Unsupported Media Type" + "status": "Unauthorized" }, { "_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": "GET", @@ -23427,27 +23705,32 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters", - ":hybridClusterId" + "v1", + "analytics", + "meetingsMetrics", + "aggregates" ], "query": [ { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ + }, { - "description": "The ID of the cluster.", - "key": "hybridClusterId" + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } }, - "status": "Unauthorized" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -23464,24 +23747,29 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters", - ":hybridClusterId" + "v1", + "analytics", + "meetingsMetrics", + "aggregates" ], "query": [ { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ + }, { - "description": "The ID of the cluster.", - "key": "hybridClusterId" + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } }, "status": "Service Unavailable" @@ -23501,82 +23789,82 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters", - ":hybridClusterId" + "v1", + "analytics", + "meetingsMetrics", + "aggregates" ], "query": [ { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ + }, { - "description": "The ID of the cluster.", - "key": "hybridClusterId" + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } }, "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"orgId\": \"\",\n \"name\": \"\",\n \"resourceGroupId\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 428, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters", - ":hybridClusterId" + "v1", + "analytics", + "meetingsMetrics", + "aggregates" ], "query": [ { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ + }, { - "description": "The ID of the cluster.", - "key": "hybridClusterId" + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } }, - "status": "OK" + "status": "Precondition Required" }, { "_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", @@ -23585,35 +23873,40 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters", - ":hybridClusterId" - ], - "query": [ - { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", - "value": "" - } + "v1", + "analytics", + "meetingsMetrics", + "aggregates" ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ + "query": [ { - "description": "The ID of the cluster.", - "key": "hybridClusterId" + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", + "value": "" + }, + { + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_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", @@ -23622,35 +23915,82 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters", - ":hybridClusterId" + "v1", + "analytics", + "meetingsMetrics", + "aggregates" ], "query": [ { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", "value": "" + }, + { + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + } + }, + "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": [ + "v1", + "analytics", + "meetingsMetrics", + "aggregates" + ], + "query": [ { - "description": "The ID of the cluster.", - "key": "hybridClusterId" + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", + "value": "" + }, + { + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } }, - "status": "Gone" + "status": "Not Found" }, { "_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", @@ -23659,27 +23999,126 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters", - ":hybridClusterId" + "v1", + "analytics", + "meetingsMetrics", + "aggregates" ], "query": [ { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", + "value": "" + }, + { + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + } + ], + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"siteUrl\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"metrics\": {\n \"totalMeetings\": \"\",\n \"totalParticipants\": \"\",\n \"totalUniqueHosts\": \"\",\n \"totalMeetingMinutes\": \"\",\n \"totalAudioMinutes\": \"\",\n \"totalTelephoneMinutes\": \"\",\n \"totalVoIPMinutes\": \"\",\n \"videoMeetings\": \"\",\n \"sharingMeetings\": \"\",\n \"recordingMeetings\": \"\",\n \"participantsByJoinMethods\": {\n \"webApp\": \"\",\n \"cloudVideoDevice\": \"\",\n \"mobileMeetingsApp\": \"\"\n },\n \"participantsByRoles\": {\n \"host\": \"\",\n \"attendee\": \"\"\n },\n \"participantsByLocation\": [\n {\n \"country\": \"\",\n \"totalParticipants\": \"\"\n },\n {\n \"country\": \"\",\n \"totalParticipants\": \"\"\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": [ + "v1", + "analytics", + "meetingsMetrics", + "aggregates" + ], + "query": [ + { + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", "value": "" + }, + { + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." + } + }, + "status": "OK" + }, + { + "_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": [ + "v1", + "analytics", + "meetingsMetrics", + "aggregates" + ], + "query": [ { - "description": "The ID of the cluster.", - "key": "hybridClusterId" + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", + "value": "" + }, + { + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } }, - "status": "Bad Gateway" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", @@ -23696,24 +24135,29 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters", - ":hybridClusterId" + "v1", + "analytics", + "meetingsMetrics", + "aggregates" ], "query": [ { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ + }, { - "description": "The ID of the cluster.", - "key": "hybridClusterId" + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } }, "status": "Conflict" @@ -23721,10 +24165,10 @@ { "_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", @@ -23733,39 +24177,44 @@ "{{baseUrl}}" ], "path": [ - "hybrid", - "clusters", - ":hybridClusterId" + "v1", + "analytics", + "meetingsMetrics", + "aggregates" ], "query": [ { - "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", - "key": "orgId", + "description": "URL of the Webex site for which historical data is requested.", + "key": "siteUrl", "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", - "variable": [ + }, { - "description": "The ID of the cluster.", - "key": "hybridClusterId" + "description": "UTC Date starting from which the data needs to be returned", + "key": "from", + "value": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided" + }, + { + "description": "UTC Date up to which the data needs to be returned", + "key": "to", + "value": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates?siteUrl=&from=Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided&to=Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results." } }, - "status": "Forbidden" + "status": "Bad Gateway" } ] } ], - "name": "Hybrid Clusters" + "name": "Historical Analytics APIs" }, { "item": [ { - "name": "List Hybrid Connectors", + "name": "List Hybrid Clusters", "request": { - "description": "List hybrid connectors for an organization. If no `orgId` is specified, the default is the organization of the authenticated user.\n\nOnly an admin auth token with the `spark-admin:hybrid_connectors_read` scope can list connectors.", + "description": "List hybrid clusters for an organization. If no `orgId` is specified, the default is the organization of the authenticated user.\n\nOnly an admin auth token with the `spark-admin:hybrid_clusters_read` scope can list clusters.", "header": [ { "key": "Accept", @@ -23779,56 +24228,26 @@ ], "path": [ "hybrid", - "connectors" + "clusters" ], "query": [ { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" } }, "response": [ { "_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": [ - "hybrid", - "connectors" - ], - "query": [ - { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" - } - }, - "status": "Gone" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 428, + "code": 409, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "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", @@ -23838,27 +24257,27 @@ ], "path": [ "hybrid", - "connectors" + "clusters" ], "query": [ { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" } }, - "status": "Precondition Required" + "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", @@ -23868,27 +24287,27 @@ ], "path": [ "hybrid", - "connectors" + "clusters" ], "query": [ { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" } }, - "status": "Bad Request" + "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", @@ -23898,27 +24317,27 @@ ], "path": [ "hybrid", - "connectors" + "clusters" ], "query": [ { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" } }, - "status": "Service Unavailable" + "status": "Unauthorized" }, { "_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", @@ -23928,27 +24347,27 @@ ], "path": [ "hybrid", - "connectors" + "clusters" ], "query": [ { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" } }, - "status": "Not Found" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 429, "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": "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", @@ -23958,23 +24377,23 @@ ], "path": [ "hybrid", - "connectors" + "clusters" ], "query": [ { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" } }, - "status": "Gateway Timeout" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"orgId\": \"\",\n \"hybridClusterId\": \"\",\n \"hostname\": \"\",\n \"status\": \"impaired\",\n \"created\": \"\",\n \"type\": \"expresswayServiceability\",\n \"version\": \"\",\n \"alarms\": [\n {\n \"id\": \"\",\n \"created\": \"\",\n \"severity\": \"error\",\n \"title\": \"\",\n \"description\": \"\",\n \"hybridConnectorId\": \"\"\n },\n {\n \"id\": \"\",\n \"created\": \"\",\n \"severity\": \"error\",\n \"title\": \"\",\n \"description\": \"\",\n \"hybridConnectorId\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"orgId\": \"\",\n \"hybridClusterId\": \"\",\n \"hostname\": \"\",\n \"status\": \"operational\",\n \"created\": \"\",\n \"type\": \"expresswayManagement\",\n \"version\": \"\",\n \"alarms\": [\n {\n \"id\": \"\",\n \"created\": \"\",\n \"severity\": \"error\",\n \"title\": \"\",\n \"description\": \"\",\n \"hybridConnectorId\": \"\"\n },\n {\n \"id\": \"\",\n \"created\": \"\",\n \"severity\": \"warning\",\n \"title\": \"\",\n \"description\": \"\",\n \"hybridConnectorId\": \"\"\n }\n ]\n }\n ]\n}", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"orgId\": \"\",\n \"name\": \"\",\n \"resourceGroupId\": \"\"\n },\n {\n \"id\": \"\",\n \"orgId\": \"\",\n \"name\": \"\",\n \"resourceGroupId\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -23998,16 +24417,16 @@ ], "path": [ "hybrid", - "connectors" + "clusters" ], "query": [ { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" } }, "status": "OK" @@ -24015,10 +24434,10 @@ { "_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", @@ -24028,27 +24447,27 @@ ], "path": [ "hybrid", - "connectors" + "clusters" ], "query": [ { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" } }, - "status": "Unauthorized" + "status": "Unsupported Media Type" }, { "_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", @@ -24058,27 +24477,27 @@ ], "path": [ "hybrid", - "connectors" + "clusters" ], "query": [ { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" } }, - "status": "Method Not Allowed" + "status": "Not Found" }, { "_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": { "header": [], "method": "GET", @@ -24088,27 +24507,27 @@ ], "path": [ "hybrid", - "connectors" + "clusters" ], "query": [ { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 503, "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": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -24118,27 +24537,27 @@ ], "path": [ "hybrid", - "connectors" + "clusters" ], "query": [ { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" } }, - "status": "Internal Server Error" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 502, "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 Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -24148,27 +24567,27 @@ ], "path": [ "hybrid", - "connectors" + "clusters" ], "query": [ { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" } }, - "status": "Unsupported Media Type" + "status": "Bad Gateway" }, { "_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", @@ -24178,27 +24597,27 @@ ], "path": [ "hybrid", - "connectors" + "clusters" ], "query": [ { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" } }, - "status": "Bad Gateway" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 405, "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": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -24208,27 +24627,27 @@ ], "path": [ "hybrid", - "connectors" + "clusters" ], "query": [ { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" } }, - "status": "Too Many Requests" + "status": "Method Not Allowed" }, { "_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": { "header": [], "method": "GET", @@ -24238,27 +24657,27 @@ ], "path": [ "hybrid", - "connectors" + "clusters" ], "query": [ { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" } }, - "status": "Conflict" + "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", @@ -24268,26 +24687,56 @@ ], "path": [ "hybrid", - "connectors" + "clusters" ], "query": [ { - "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" } }, - "status": "Forbidden" - } - ] + "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": [ + "hybrid", + "clusters" + ], + "query": [ + { + "description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters?orgId=" + } + }, + "status": "Forbidden" + } + ] }, { - "name": "Get Hybrid Connector Details", + "name": "Get Hybrid Cluster Details", "request": { - "description": "Shows details for a hybrid connector, by ID.\n\nOnly an admin auth token with the `spark-admin:hybrid_connectors_read` scope can see connector details.", + "description": "Shows details for a hybrid cluster, by ID.\n\nOnly an admin auth token with the `spark-admin:hybrid_clusters_read` scope can see cluster details.", "header": [ { "key": "Accept", @@ -24301,14 +24750,21 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId", + "description": "The ID of the cluster.", + "key": "hybridClusterId", "value": "" } ] @@ -24318,10 +24774,10 @@ { "_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": { "header": [], "method": "GET", @@ -24331,27 +24787,34 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId" + "description": "The ID of the cluster.", + "key": "hybridClusterId" } ] } }, - "status": "Gone" + "status": "Not Found" }, { "_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", @@ -24361,27 +24824,34 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId" + "description": "The ID of the cluster.", + "key": "hybridClusterId" } ] } }, - "status": "Precondition Required" + "status": "Gateway Timeout" }, { "_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": { "header": [], "method": "GET", @@ -24391,27 +24861,34 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId" + "description": "The ID of the cluster.", + "key": "hybridClusterId" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_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", @@ -24421,27 +24898,34 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId" + "description": "The ID of the cluster.", + "key": "hybridClusterId" } ] } }, - "status": "Forbidden" + "status": "Precondition Required" }, { "_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": { "header": [], "method": "GET", @@ -24451,27 +24935,34 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId" + "description": "The ID of the cluster.", + "key": "hybridClusterId" } ] } }, - "status": "Gateway Timeout" + "status": "Method Not Allowed" }, { "_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": "GET", @@ -24481,39 +24972,36 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId" + "description": "The ID of the cluster.", + "key": "hybridClusterId" } ] } }, - "status": "Internal Server Error" + "status": "Locked (WebDAV) (RFC 4918)" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"orgId\": \"\",\n \"hybridClusterId\": \"\",\n \"hostname\": \"\",\n \"status\": \"outage\",\n \"created\": \"\",\n \"type\": \"videoMesh\",\n \"version\": \"\",\n \"alarms\": [\n {\n \"id\": \"\",\n \"created\": \"\",\n \"severity\": \"critical\",\n \"title\": \"\",\n \"description\": \"\",\n \"hybridConnectorId\": \"\"\n },\n {\n \"id\": \"\",\n \"created\": \"\",\n \"severity\": \"critical\",\n \"title\": \"\",\n \"description\": \"\",\n \"hybridConnectorId\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 415, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -24521,27 +25009,34 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId" + "description": "The ID of the cluster.", + "key": "hybridClusterId" } ] } }, - "status": "OK" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 401, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], "method": "GET", @@ -24551,27 +25046,34 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId" + "description": "The ID of the cluster.", + "key": "hybridClusterId" } ] } }, - "status": "Bad Gateway" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 503, "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": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -24581,27 +25083,34 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId" + "description": "The ID of the cluster.", + "key": "hybridClusterId" } ] } }, - "status": "Too Many Requests" + "status": "Service Unavailable" }, { "_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", @@ -24611,29 +25120,46 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId" + "description": "The ID of the cluster.", + "key": "hybridClusterId" } ] } }, - "status": "Method Not Allowed" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"orgId\": \"\",\n \"name\": \"\",\n \"resourceGroupId\": \"\"\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": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ @@ -24641,19 +25167,26 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId" + "description": "The ID of the cluster.", + "key": "hybridClusterId" } ] } }, - "status": "Service Unavailable" + "status": "OK" }, { "_postman_previewlanguage": "text", @@ -24671,14 +25204,21 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId" + "description": "The ID of the cluster.", + "key": "hybridClusterId" } ] } @@ -24688,10 +25228,10 @@ { "_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", @@ -24701,27 +25241,34 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId" + "description": "The ID of the cluster.", + "key": "hybridClusterId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gone" }, { "_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": { "header": [], "method": "GET", @@ -24731,27 +25278,34 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId" + "description": "The ID of the cluster.", + "key": "hybridClusterId" } ] } }, - "status": "Conflict" + "status": "Bad Gateway" }, { "_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": { "header": [], "method": "GET", @@ -24761,27 +25315,34 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId" + "description": "The ID of the cluster.", + "key": "hybridClusterId" } ] } }, - "status": "Unsupported Media Type" + "status": "Conflict" }, { "_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", @@ -24791,31 +25352,38 @@ ], "path": [ "hybrid", - "connectors", - ":connectorId" + "clusters", + ":hybridClusterId" ], - "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", + "query": [ + { + "description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/clusters/:hybridClusterId?orgId=", "variable": [ { - "description": "The ID of the connector.", - "key": "connectorId" + "description": "The ID of the cluster.", + "key": "hybridClusterId" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" } ] } ], - "name": "Hybrid Connectors" + "name": "Hybrid Clusters" }, { "item": [ { - "name": "List Licenses", + "name": "List Hybrid Connectors", "request": { - "description": "List all licenses for a given organization. If no `orgId` is specified, the default is the organization of the authenticated user.\n\nResponse properties that are not applicable to the license will not be present in the response.", + "description": "List hybrid connectors for an organization. If no `orgId` is specified, the default is the organization of the authenticated user.\n\nOnly an admin auth token with the `spark-admin:hybrid_connectors_read` scope can list connectors.", "header": [ { "key": "Accept", @@ -24828,26 +25396,27 @@ "{{baseUrl}}" ], "path": [ - "licenses" + "hybrid", + "connectors" ], "query": [ { - "description": "List licenses for this organization.", + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/licenses?orgId=" + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 410, "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": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -24856,27 +25425,28 @@ "{{baseUrl}}" ], "path": [ - "licenses" + "hybrid", + "connectors" ], "query": [ { - "description": "List licenses for this organization.", + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/licenses?orgId=" + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" } }, - "status": "Internal Server Error" + "status": "Gone" }, { "_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", @@ -24885,27 +25455,28 @@ "{{baseUrl}}" ], "path": [ - "licenses" + "hybrid", + "connectors" ], "query": [ { - "description": "List licenses for this organization.", + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/licenses?orgId=" + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" } }, - "status": "Unauthorized" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 400, "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 Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], "method": "GET", @@ -24914,27 +25485,28 @@ "{{baseUrl}}" ], "path": [ - "licenses" + "hybrid", + "connectors" ], "query": [ { - "description": "List licenses for this organization.", + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/licenses?orgId=" + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" } }, - "status": "Conflict" + "status": "Bad Request" }, { "_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", @@ -24943,56 +25515,28 @@ "{{baseUrl}}" ], "path": [ - "licenses" + "hybrid", + "connectors" ], "query": [ { - "description": "List licenses for this organization.", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/licenses?orgId=" - } - }, - "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": [ - "licenses" - ], - "query": [ - { - "description": "List licenses for this organization.", + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/licenses?orgId=" + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" } }, - "status": "Bad Gateway" + "status": "Service Unavailable" }, { "_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": "GET", @@ -25001,19 +25545,20 @@ "{{baseUrl}}" ], "path": [ - "licenses" + "hybrid", + "connectors" ], "query": [ { - "description": "List licenses for this organization.", + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/licenses?orgId=" + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "text", @@ -25030,23 +25575,24 @@ "{{baseUrl}}" ], "path": [ - "licenses" + "hybrid", + "connectors" ], "query": [ { - "description": "List licenses for this organization.", + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/licenses?orgId=" + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" } }, "status": "Gateway Timeout" }, { "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"totalUnits\": \"\",\n \"consumedUnits\": \"\",\n \"consumedByUsers\": \"\",\n \"consumedByWorkspaces\": \"\",\n \"subscriptionId\": \"\",\n \"siteUrl\": \"\",\n \"siteType\": \"Linked site\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"totalUnits\": \"\",\n \"consumedUnits\": \"\",\n \"consumedByUsers\": \"\",\n \"consumedByWorkspaces\": \"\",\n \"subscriptionId\": \"\",\n \"siteUrl\": \"\",\n \"siteType\": \"Site Admin managed site\"\n }\n ]\n}", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"orgId\": \"\",\n \"hybridClusterId\": \"\",\n \"hostname\": \"\",\n \"status\": \"impaired\",\n \"created\": \"\",\n \"type\": \"expresswayServiceability\",\n \"version\": \"\",\n \"alarms\": [\n {\n \"id\": \"\",\n \"created\": \"\",\n \"severity\": \"error\",\n \"title\": \"\",\n \"description\": \"\",\n \"hybridConnectorId\": \"\"\n },\n {\n \"id\": \"\",\n \"created\": \"\",\n \"severity\": \"error\",\n \"title\": \"\",\n \"description\": \"\",\n \"hybridConnectorId\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"orgId\": \"\",\n \"hybridClusterId\": \"\",\n \"hostname\": \"\",\n \"status\": \"operational\",\n \"created\": \"\",\n \"type\": \"expresswayManagement\",\n \"version\": \"\",\n \"alarms\": [\n {\n \"id\": \"\",\n \"created\": \"\",\n \"severity\": \"error\",\n \"title\": \"\",\n \"description\": \"\",\n \"hybridConnectorId\": \"\"\n },\n {\n \"id\": \"\",\n \"created\": \"\",\n \"severity\": \"warning\",\n \"title\": \"\",\n \"description\": \"\",\n \"hybridConnectorId\": \"\"\n }\n ]\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -25069,16 +25615,17 @@ "{{baseUrl}}" ], "path": [ - "licenses" + "hybrid", + "connectors" ], "query": [ { - "description": "List licenses for this organization.", + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/licenses?orgId=" + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" } }, "status": "OK" @@ -25086,10 +25633,10 @@ { "_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": "GET", @@ -25098,19 +25645,20 @@ "{{baseUrl}}" ], "path": [ - "licenses" + "hybrid", + "connectors" ], "query": [ { - "description": "List licenses for this organization.", + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/licenses?orgId=" + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" } }, - "status": "Bad Request" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -25127,16 +25675,17 @@ "{{baseUrl}}" ], "path": [ - "licenses" + "hybrid", + "connectors" ], "query": [ { - "description": "List licenses for this organization.", + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/licenses?orgId=" + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" } }, "status": "Method Not Allowed" @@ -25144,10 +25693,10 @@ { "_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", @@ -25156,27 +25705,28 @@ "{{baseUrl}}" ], "path": [ - "licenses" + "hybrid", + "connectors" ], "query": [ { - "description": "List licenses for this organization.", + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/licenses?orgId=" + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" } }, - "status": "Not Found" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { "header": [], "method": "GET", @@ -25185,27 +25735,28 @@ "{{baseUrl}}" ], "path": [ - "licenses" + "hybrid", + "connectors" ], "query": [ { - "description": "List licenses for this organization.", + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/licenses?orgId=" + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_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", @@ -25214,27 +25765,28 @@ "{{baseUrl}}" ], "path": [ - "licenses" + "hybrid", + "connectors" ], "query": [ { - "description": "List licenses for this organization.", + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/licenses?orgId=" + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" } }, - "status": "Precondition Required" + "status": "Unsupported Media Type" }, { "_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", @@ -25243,27 +25795,28 @@ "{{baseUrl}}" ], "path": [ - "licenses" + "hybrid", + "connectors" ], "query": [ { - "description": "List licenses for this organization.", + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/licenses?orgId=" + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" } }, - "status": "Gone" + "status": "Bad Gateway" }, { "_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", @@ -25272,19 +25825,50 @@ "{{baseUrl}}" ], "path": [ - "licenses" + "hybrid", + "connectors" ], "query": [ { - "description": "List licenses for this organization.", + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/licenses?orgId=" + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" } }, - "status": "Unsupported Media Type" + "status": "Too Many Requests" + }, + { + "_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": [ + "hybrid", + "connectors" + ], + "query": [ + { + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" + } + }, + "status": "Conflict" }, { "_postman_previewlanguage": "text", @@ -25301,16 +25885,17 @@ "{{baseUrl}}" ], "path": [ - "licenses" + "hybrid", + "connectors" ], "query": [ { - "description": "List licenses for this organization.", + "description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/licenses?orgId=" + "raw": "{{baseUrl}}/hybrid/connectors?orgId=" } }, "status": "Forbidden" @@ -25318,9 +25903,9 @@ ] }, { - "name": "Get License Details", + "name": "Get Hybrid Connector Details", "request": { - "description": "Shows details for a license, by ID.\n\nSpecify the license ID in the `licenseId` parameter in the URI.\nUse the optional query parameter `includeAssignedTo` to get a list of all objects that are assigned with the license. The objects include but not limited to, users including external users. Long result sets will be split into [pages](/docs/basics#pagination).\n\nResponse properties that are not applicable to the license will not be present in the response.", + "description": "Shows details for a hybrid connector, by ID.\n\nOnly an admin auth token with the `spark-admin:hybrid_connectors_read` scope can see connector details.", "header": [ { "key": "Accept", @@ -25333,31 +25918,15 @@ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" - ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } + "hybrid", + "connectors", + ":connectorId" ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId", + "description": "The ID of the connector.", + "key": "connectorId", "value": "" } ] @@ -25367,10 +25936,10 @@ { "_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": { "header": [], "method": "GET", @@ -25379,44 +25948,28 @@ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" - ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } + "hybrid", + "connectors", + ":connectorId" ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId" + "description": "The ID of the connector.", + "key": "connectorId" } ] } }, - "status": "Unsupported Media Type" + "status": "Gone" }, { "_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": { "header": [], "method": "GET", @@ -25425,44 +25978,28 @@ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" - ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } + "hybrid", + "connectors", + ":connectorId" ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId" + "description": "The ID of the connector.", + "key": "connectorId" } ] } }, - "status": "Not Found" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 404, "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": "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", @@ -25471,36 +26008,20 @@ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" - ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } + "hybrid", + "connectors", + ":connectorId" ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId" + "description": "The ID of the connector.", + "key": "connectorId" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "text", @@ -25517,31 +26038,15 @@ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" - ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } + "hybrid", + "connectors", + ":connectorId" ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId" + "description": "The ID of the connector.", + "key": "connectorId" } ] } @@ -25551,10 +26056,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 504, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -25563,44 +26068,28 @@ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" - ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } + "hybrid", + "connectors", + ":connectorId" ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId" + "description": "The ID of the connector.", + "key": "connectorId" } ] } }, - "status": "Bad Request" + "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": "GET", @@ -25609,90 +26098,68 @@ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" - ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } + "hybrid", + "connectors", + ":connectorId" ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId" + "description": "The ID of the connector.", + "key": "connectorId" } ] } }, - "status": "Conflict" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 428, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"orgId\": \"\",\n \"hybridClusterId\": \"\",\n \"hostname\": \"\",\n \"status\": \"outage\",\n \"created\": \"\",\n \"type\": \"videoMesh\",\n \"version\": \"\",\n \"alarms\": [\n {\n \"id\": \"\",\n \"created\": \"\",\n \"severity\": \"critical\",\n \"title\": \"\",\n \"description\": \"\",\n \"hybridConnectorId\": \"\"\n },\n {\n \"id\": \"\",\n \"created\": \"\",\n \"severity\": \"critical\",\n \"title\": \"\",\n \"description\": \"\",\n \"hybridConnectorId\": \"\"\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": [ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" - ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } + "hybrid", + "connectors", + ":connectorId" ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId" + "description": "The ID of the connector.", + "key": "connectorId" } ] } }, - "status": "Precondition Required" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 502, "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 Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -25701,44 +26168,28 @@ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" - ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } + "hybrid", + "connectors", + ":connectorId" ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId" + "description": "The ID of the connector.", + "key": "connectorId" } ] } }, - "status": "Gateway Timeout" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 429, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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", @@ -25747,36 +26198,20 @@ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" + "hybrid", + "connectors", + ":connectorId" ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } - ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId" + "description": "The ID of the connector.", + "key": "connectorId" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", @@ -25793,31 +26228,15 @@ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" - ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } + "hybrid", + "connectors", + ":connectorId" ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId" + "description": "The ID of the connector.", + "key": "connectorId" } ] } @@ -25839,31 +26258,15 @@ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" - ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } + "hybrid", + "connectors", + ":connectorId" ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId" + "description": "The ID of the connector.", + "key": "connectorId" } ] } @@ -25873,10 +26276,10 @@ { "_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", @@ -25885,44 +26288,28 @@ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" - ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } + "hybrid", + "connectors", + ":connectorId" ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId" + "description": "The ID of the connector.", + "key": "connectorId" } ] } }, - "status": "Bad Gateway" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 423, "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": "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", @@ -25931,44 +26318,28 @@ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" - ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } + "hybrid", + "connectors", + ":connectorId" ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId" + "description": "The ID of the connector.", + "key": "connectorId" } ] } }, - "status": "Too Many Requests" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", @@ -25977,109 +26348,58 @@ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" - ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } + "hybrid", + "connectors", + ":connectorId" ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId" + "description": "The ID of the connector.", + "key": "connectorId" } ] } }, - "status": "Gone" + "status": "Conflict" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"totalUnits\": \"\",\n \"consumedUnits\": \"\",\n \"consumedByUsers\": \"\",\n \"consumedByWorkspaces\": \"\",\n \"subscriptionId\": \"\",\n \"siteUrl\": \"\",\n \"siteType\": \"Control Hub managed site\",\n \"users\": [\n {\n \"id\": \"\",\n \"type\": \"EXTERNAL\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"INTERNAL\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 415, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" - } - ], - "name": "OK", + "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": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" - ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } + "hybrid", + "connectors", + ":connectorId" ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId" + "description": "The ID of the connector.", + "key": "connectorId" } ] } }, - "status": "OK" + "status": "Unsupported Media Type" }, { "_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", @@ -26088,160 +26408,114 @@ "{{baseUrl}}" ], "path": [ - "licenses", - ":licenseId" - ], - "query": [ - { - "description": "The type of object to whom the license is assigned to.", - "key": "includeAssignedTo", - "value": "user" - }, - { - "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", - "key": "next", - "value": "" - }, - { - "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", - "key": "limit", - "value": "300" - } + "hybrid", + "connectors", + ":connectorId" ], - "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "raw": "{{baseUrl}}/hybrid/connectors/:connectorId", "variable": [ { - "description": "The unique identifier for the license.", - "key": "licenseId" + "description": "The ID of the connector.", + "key": "connectorId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unauthorized" } ] - }, + } + ], + "name": "Hybrid Connectors" + }, + { + "item": [ { - "name": "Assign Licenses to Users", + "name": "List Licenses", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "description": "Assign licenses and attendee `siteUrls` to existing users. Only an admin can assign licenses. Only existing users can be assigned a license. Assign meeting licenses to users outside your organization (Status will be pending until the user accepts the invite)\n\nAt least one of the following body parameters is required to assign license to the user: `email`, `personId`. For Calling license assignment, properties `phoneNumber` or `extension` are required. If `phoneNumber` is not provided then `locationId` is mandatory.\n\nWhen assigning licenses and attendee siteUrls to a user who does not belong to the organization, the licenses and siteUrls remain in pending state until the user accepts them. The `pendingLicenses` and `pendingSiteUrls` are part of the response.", + "description": "List all licenses for a given organization. If no `orgId` is specified, the default is the organization of the authenticated user.\n\nResponse properties that are not applicable to the license will not be present in the response.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/licenses?orgId=" } }, "response": [ { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/licenses?orgId=" } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"orgId\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"host\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\"\n }\n ],\n \"pendingLicenses\": [\n \"\",\n \"\"\n ],\n \"pendingSiteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/licenses?orgId=" } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -26251,32 +26525,23 @@ "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 \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/licenses?orgId=" } }, "status": "Conflict" @@ -26284,344 +26549,273 @@ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/licenses?orgId=" } }, - "status": "Unauthorized" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 502, "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 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 \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/licenses?orgId=" } }, - "status": "Gateway Timeout" + "status": "Bad Gateway" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/licenses?orgId=" } }, - "status": "Service Unavailable" + "status": "Too Many Requests" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/licenses?orgId=" } }, - "status": "Unsupported Media Type" + "status": "Gateway Timeout" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 429, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"totalUnits\": \"\",\n \"consumedUnits\": \"\",\n \"consumedByUsers\": \"\",\n \"consumedByWorkspaces\": \"\",\n \"subscriptionId\": \"\",\n \"siteUrl\": \"\",\n \"siteType\": \"Linked site\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"totalUnits\": \"\",\n \"consumedUnits\": \"\",\n \"consumedByUsers\": \"\",\n \"consumedByWorkspaces\": \"\",\n \"subscriptionId\": \"\",\n \"siteUrl\": \"\",\n \"siteType\": \"Site Admin managed site\"\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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/licenses?orgId=" } }, - "status": "Too Many Requests" + "status": "OK" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/licenses?orgId=" } }, - "status": "Not Found" + "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/licenses?orgId=" } }, - "status": "Bad Gateway" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 404, "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": "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 \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/licenses?orgId=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/licenses?orgId=" } }, - "status": "Method Not Allowed" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", @@ -26631,82 +26825,26 @@ "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 \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" - } - }, - "status": "Precondition Required" - }, - { - "_postman_previewlanguage": "text", - "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"errorCode\": 400411,\n \"description\": \"\"\n },\n {\n \"errorCode\": 400404,\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. Specific error codes indicate license assignment issues.", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" } - }, - "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PATCH", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "licenses", - "users" ], - "raw": "{{baseUrl}}/licenses/users" + "raw": "{{baseUrl}}/licenses?orgId=" } }, - "status": "Bad Request" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", @@ -26716,32 +26854,23 @@ "header": [], "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/licenses?orgId=" } }, "status": "Gone" @@ -26749,99 +26878,67 @@ { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/licenses?orgId=" } }, - "status": "Internal Server Error" + "status": "Unsupported Media Type" }, { - "_postman_previewlanguage": "Text", - "body": "{\n \"orgId\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"host\"\n }\n ],\n \"pendingLicenses\": [\n \"\",\n \"\"\n ],\n \"pendingSiteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"host\"\n }\n ]\n}", - "code": 206, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Partial Content: Some licenses were successfully assigned, but others could not be assigned due to various constraints or errors. Compare the returned licenses with the requested licenses to determine which ones failed.", + "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 \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"remove\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"remove\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "licenses", - "users" + "licenses" ], - "raw": "{{baseUrl}}/licenses/users" + "query": [ + { + "description": "List licenses for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/licenses?orgId=" } }, - "status": "Partial Content" + "status": "Forbidden" } ] - } - ], - "name": "Licenses" - }, - { - "item": [ + }, { - "name": "Get Meeting Qualities", + "name": "Get License Details", "request": { - "description": "Get quality data for a meeting, by `meetingId`. Only organization administrators can retrieve meeting quality data.", + "description": "Shows details for a license, by ID.\n\nSpecify the license ID in the `licenseId` parameter in the URI.\nUse the optional query parameter `includeAssignedTo` to get a list of all objects that are assigned with the license. The objects include but not limited to, users including external users. Long result sets will be split into [pages](/docs/basics#pagination).\n\nResponse properties that are not applicable to the license will not be present in the response.", "header": [ { "key": "Accept", @@ -26854,37 +26951,44 @@ "{{baseUrl}}" ], "path": [ - "meeting", - "qualities" + "licenses", + ":licenseId" ], "query": [ { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", - "value": "" + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" }, { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", + "value": "" }, { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" } ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ + { + "description": "The unique identifier for the license.", + "key": "licenseId", + "value": "" + } + ] } }, "response": [ { "_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", @@ -26893,38 +26997,44 @@ "{{baseUrl}}" ], "path": [ - "meeting", - "qualities" + "licenses", + ":licenseId" ], "query": [ { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", - "value": "" - }, + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" + }, { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", + "value": "" }, { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" } ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ + { + "description": "The unique identifier for the license.", + "key": "licenseId" + } + ] } }, - "status": "Precondition Required" + "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", @@ -26933,38 +27043,44 @@ "{{baseUrl}}" ], "path": [ - "meeting", - "qualities" + "licenses", + ":licenseId" ], "query": [ { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", - "value": "" + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" }, { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", + "value": "" }, { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" } ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ + { + "description": "The unique identifier for the license.", + "key": "licenseId" + } + ] } }, - "status": "Gateway Timeout" + "status": "Not Found" }, { "_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": { "header": [], "method": "GET", @@ -26973,38 +27089,44 @@ "{{baseUrl}}" ], "path": [ - "meeting", - "qualities" + "licenses", + ":licenseId" ], "query": [ { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", - "value": "" + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" }, { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", + "value": "" }, { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" } ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ + { + "description": "The unique identifier for the license.", + "key": "licenseId" + } + ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_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", @@ -27013,38 +27135,44 @@ "{{baseUrl}}" ], "path": [ - "meeting", - "qualities" + "licenses", + ":licenseId" ], "query": [ { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", - "value": "" + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" }, { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", + "value": "" }, { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" } ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ + { + "description": "The unique identifier for the license.", + "key": "licenseId" + } + ] } }, - "status": "Bad Gateway" + "status": "Forbidden" }, { "_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": { "header": [], "method": "GET", @@ -27053,38 +27181,44 @@ "{{baseUrl}}" ], "path": [ - "meeting", - "qualities" + "licenses", + ":licenseId" ], "query": [ { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", - "value": "" + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" }, { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", + "value": "" }, { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" } ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ + { + "description": "The unique identifier for the license.", + "key": "licenseId" + } + ] } }, - "status": "Unsupported Media Type" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 409, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. 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": "GET", @@ -27093,38 +27227,44 @@ "{{baseUrl}}" ], "path": [ - "meeting", - "qualities" + "licenses", + ":licenseId" ], "query": [ { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", - "value": "" + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" }, { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", + "value": "" }, { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" } ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ + { + "description": "The unique identifier for the license.", + "key": "licenseId" + } + ] } }, - "status": "Service Unavailable" + "status": "Conflict" }, { "_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", @@ -27133,38 +27273,44 @@ "{{baseUrl}}" ], "path": [ - "meeting", - "qualities" + "licenses", + ":licenseId" ], "query": [ { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", - "value": "" + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" }, { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", + "value": "" }, { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" } ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ + { + "description": "The unique identifier for the license.", + "key": "licenseId" + } + ] } }, - "status": "Method Not Allowed" + "status": "Precondition Required" }, { "_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", @@ -27173,38 +27319,44 @@ "{{baseUrl}}" ], "path": [ - "meeting", - "qualities" + "licenses", + ":licenseId" ], "query": [ { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", - "value": "" + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" }, { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", + "value": "" }, { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" } ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ + { + "description": "The unique identifier for the license.", + "key": "licenseId" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_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", @@ -27213,38 +27365,44 @@ "{{baseUrl}}" ], "path": [ - "meeting", - "qualities" + "licenses", + ":licenseId" ], "query": [ { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", - "value": "" + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" }, { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", + "value": "" }, { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" } ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ + { + "description": "The unique identifier for the license.", + "key": "licenseId" + } + ] } }, - "status": "Not Found" + "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": "GET", @@ -27253,97 +27411,44 @@ "{{baseUrl}}" ], "path": [ - "meeting", - "qualities" + "licenses", + ":licenseId" ], "query": [ { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", - "value": "" + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" }, { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", + "value": "" }, { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" } ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"meetingInstanceId\": \"\",\n \"webexUserName\": \"\",\n \"webexUserEmail\": \"\",\n \"joinTime\": \"\",\n \"leaveTime\": \"\",\n \"joinMeetingTime\": \"\",\n \"clientType\": \"\",\n \"clientVersion\": \"\",\n \"osType\": \"\",\n \"osVersion\": \"\",\n \"hardwareType\": \"\",\n \"speakerName\": \"\",\n \"networkType\": \"cellular\",\n \"localIP\": \"\",\n \"publicIP\": \"\",\n \"maskedLocalIP\": \"\",\n \"maskedPublicIP\": \"\",\n \"camera\": \"\",\n \"microphone\": \"\",\n \"serverRegion\": \"\",\n \"videoMeshCluster\": \"\",\n \"videoMeshServer\": \"\",\n \"participantId\": \"\",\n \"participantSessionId\": \"\",\n \"videoIn\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n }\n ],\n \"videoOut\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n }\n ],\n \"audioIn\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n }\n ],\n \"audioOut\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n }\n ],\n \"shareIn\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n }\n ],\n \"shareOut\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n }\n ],\n \"resources\": [\n {\n \"processAverageCPU\": [\n \"\",\n \"\"\n ],\n \"processMaxCPU\": [\n \"\",\n \"\"\n ],\n \"systemAverageCPU\": [\n \"\",\n \"\"\n ],\n \"systemMaxCPU\": [\n \"\",\n \"\"\n ]\n },\n {\n \"processAverageCPU\": [\n \"\",\n \"\"\n ],\n \"processMaxCPU\": [\n \"\",\n \"\"\n ],\n \"systemAverageCPU\": [\n \"\",\n \"\"\n ],\n \"systemMaxCPU\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"meetingInstanceId\": \"\",\n \"webexUserName\": \"\",\n \"webexUserEmail\": \"\",\n \"joinTime\": \"\",\n \"leaveTime\": \"\",\n \"joinMeetingTime\": \"\",\n \"clientType\": \"\",\n \"clientVersion\": \"\",\n \"osType\": \"\",\n \"osVersion\": \"\",\n \"hardwareType\": \"\",\n \"speakerName\": \"\",\n \"networkType\": \"unknown\",\n \"localIP\": \"\",\n \"publicIP\": \"\",\n \"maskedLocalIP\": \"\",\n \"maskedPublicIP\": \"\",\n \"camera\": \"\",\n \"microphone\": \"\",\n \"serverRegion\": \"\",\n \"videoMeshCluster\": \"\",\n \"videoMeshServer\": \"\",\n \"participantId\": \"\",\n \"participantSessionId\": \"\",\n \"videoIn\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n }\n ],\n \"videoOut\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n }\n ],\n \"audioIn\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n }\n ],\n \"audioOut\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n }\n ],\n \"shareIn\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n }\n ],\n \"shareOut\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n }\n ],\n \"resources\": [\n {\n \"processAverageCPU\": [\n \"\",\n \"\"\n ],\n \"processMaxCPU\": [\n \"\",\n \"\"\n ],\n \"systemAverageCPU\": [\n \"\",\n \"\"\n ],\n \"systemMaxCPU\": [\n \"\",\n \"\"\n ]\n },\n {\n \"processAverageCPU\": [\n \"\",\n \"\"\n ],\n \"processMaxCPU\": [\n \"\",\n \"\"\n ],\n \"systemAverageCPU\": [\n \"\",\n \"\"\n ],\n \"systemMaxCPU\": [\n \"\",\n \"\"\n ]\n }\n ]\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": [ - "meeting", - "qualities" - ], - "query": [ - { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", - "value": "" - }, - { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" - }, + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "The unique identifier for the license.", + "key": "licenseId" } - ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" + ] } }, - "status": "OK" + "status": "Method Not Allowed" }, { "_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", @@ -27352,38 +27457,44 @@ "{{baseUrl}}" ], "path": [ - "meeting", - "qualities" + "licenses", + ":licenseId" ], "query": [ { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", - "value": "" + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" }, { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", + "value": "" }, { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" } ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ + { + "description": "The unique identifier for the license.", + "key": "licenseId" + } + ] } }, - "status": "Gone" + "status": "Service Unavailable" }, { "_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", @@ -27392,30 +27503,36 @@ "{{baseUrl}}" ], "path": [ - "meeting", - "qualities" + "licenses", + ":licenseId" ], "query": [ { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", - "value": "" + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" }, { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", + "value": "" }, { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" } ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ + { + "description": "The unique identifier for the license.", + "key": "licenseId" + } + ] } }, - "status": "Internal Server Error" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", @@ -27432,27 +27549,33 @@ "{{baseUrl}}" ], "path": [ - "meeting", - "qualities" + "licenses", + ":licenseId" ], "query": [ { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", - "value": "" + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" }, { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", + "value": "" }, { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" } ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ + { + "description": "The unique identifier for the license.", + "key": "licenseId" + } + ] } }, "status": "Too Many Requests" @@ -27460,10 +27583,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 410, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -27472,38 +27595,109 @@ "{{baseUrl}}" ], "path": [ - "meeting", - "qualities" + "licenses", + ":licenseId" ], "query": [ { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" + }, + { + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", "value": "" }, { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" + } + ], + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ + { + "description": "The unique identifier for the license.", + "key": "licenseId" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"totalUnits\": \"\",\n \"consumedUnits\": \"\",\n \"consumedByUsers\": \"\",\n \"consumedByWorkspaces\": \"\",\n \"subscriptionId\": \"\",\n \"siteUrl\": \"\",\n \"siteType\": \"Control Hub managed site\",\n \"users\": [\n {\n \"id\": \"\",\n \"type\": \"EXTERNAL\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"INTERNAL\",\n \"displayName\": \"\",\n \"email\": \"\"\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": [ + "licenses", + ":licenseId" + ], + "query": [ + { + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" }, { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", + "value": "" + }, + { + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" } ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ + { + "description": "The unique identifier for the license.", + "key": "licenseId" + } + ] } }, - "status": "Bad Request" + "status": "OK" }, { "_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": { "header": [], "method": "GET", @@ -27512,40 +27706,41 @@ "{{baseUrl}}" ], "path": [ - "meeting", - "qualities" + "licenses", + ":licenseId" ], "query": [ { - "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", - "key": "meetingId", - "value": "" + "description": "The type of object to whom the license is assigned to.", + "key": "includeAssignedTo", + "value": "user" }, { - "description": "Limit the maximum number of media sessions in the response.", - "key": "max", - "value": "100" + "description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.", + "key": "next", + "value": "" }, { - "description": "Offset from the first result that you want to fetch.", - "key": "offset", - "value": "" + "description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.", + "key": "limit", + "value": "300" } ], - "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" + "raw": "{{baseUrl}}/licenses/:licenseId?includeAssignedTo=user&next=&limit=300", + "variable": [ + { + "description": "The unique identifier for the license.", + "key": "licenseId" + } + ] } }, - "status": "Conflict" + "status": "Locked (WebDAV) (RFC 4918)" } ] - } - ], - "name": "Meeting Qualities" - }, - { - "item": [ + }, { - "name": "Create a Contact", + "name": "Assign Licenses to Users", "request": { "body": { "mode": "raw", @@ -27555,9 +27750,9 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, - "description": "Creating a new contact for a given organization requires an org admin role.\n\nAt least one of the following body parameters: `phoneNumbers`, `emails`, `sipAddresses` is required to create a new contact for source \"CH\",\n`displayName` is required to create a new contact for source \"Webex4Broadworks\".\n\nUse the optional `groupIds` field to add group IDs in an array within the organisation contact. This will become a group contact.", + "description": "Assign licenses and attendee `siteUrls` to existing users. Only an admin can assign licenses. Only existing users can be assigned a license. Assign meeting licenses to users outside your organization (Status will be pending until the user accepts the invite)\n\nAt least one of the following body parameters is required to assign license to the user: `email`, `personId`. For Calling license assignment, properties `phoneNumber` or `extension` are required. If `phoneNumber` is not provided then `locationId` is mandatory.\n\nWhen assigning licenses and attendee siteUrls to a user who does not belong to the organization, the licenses and siteUrls remain in pending state until the user accepts them. The `pendingLicenses` and `pendingSiteUrls` are part of the response.", "header": [ { "key": "Content-Type", @@ -27568,35 +27763,26 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId", - "value": "" - } - ] + "raw": "{{baseUrl}}/licenses/users" } }, "response": [ { "_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": { "body": { "mode": "raw", @@ -27606,7 +27792,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, "header": [ { @@ -27614,35 +27800,32 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/licenses/users" } }, - "status": "Bad Request" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 502, + "_postman_previewlanguage": "json", + "body": "{\n \"orgId\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"host\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\"\n }\n ],\n \"pendingLicenses\": [\n \"\",\n \"\"\n ],\n \"pendingSiteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\"\n }\n ]\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": { "body": { "mode": "raw", @@ -27652,43 +27835,39 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/licenses/users" } }, - "status": "Bad Gateway" + "status": "OK" }, { "_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": { "body": { "mode": "raw", @@ -27698,7 +27877,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, "header": [ { @@ -27706,35 +27885,27 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/licenses/users" } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_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": { "body": { "mode": "raw", @@ -27744,7 +27915,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, "header": [ { @@ -27752,35 +27923,27 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/licenses/users" } }, - "status": "Service Unavailable" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 504, "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": "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", @@ -27790,7 +27953,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, "header": [ { @@ -27798,35 +27961,27 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/licenses/users" } }, - "status": "Not Found" + "status": "Gateway Timeout" }, { "_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", @@ -27836,7 +27991,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, "header": [ { @@ -27844,27 +27999,19 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/licenses/users" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", @@ -27882,7 +28029,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, "header": [ { @@ -27890,24 +28037,16 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/licenses/users" } }, "status": "Unsupported Media Type" @@ -27915,10 +28054,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 429, "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": "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", @@ -27928,7 +28067,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, "header": [ { @@ -27936,35 +28075,27 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/licenses/users" } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_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": { "body": { "mode": "raw", @@ -27974,7 +28105,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, "header": [ { @@ -27982,35 +28113,27 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/licenses/users" } }, - "status": "Method Not Allowed" + "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": { "body": { "mode": "raw", @@ -28020,7 +28143,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, "header": [ { @@ -28028,35 +28151,27 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/licenses/users" } }, - "status": "Gone" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 423, "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": "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", @@ -28066,7 +28181,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, "header": [ { @@ -28074,35 +28189,27 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/licenses/users" } }, - "status": "Too Many Requests" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", @@ -28112,7 +28219,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, "header": [ { @@ -28120,35 +28227,27 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/licenses/users" } }, - "status": "Gateway Timeout" + "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": { "body": { "mode": "raw", @@ -28158,7 +28257,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, "header": [ { @@ -28166,35 +28265,32 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/licenses/users" } }, - "status": "Forbidden" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", - "body": null, - "code": 428, + "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"errorCode\": 400411,\n \"description\": \"\"\n },\n {\n \"errorCode\": 400404,\n \"description\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "code": 400, "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": "Bad Request: The request was invalid or cannot be otherwise served. Specific error codes indicate license assignment issues.", "originalRequest": { "body": { "mode": "raw", @@ -28204,48 +28300,39 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/licenses/users" } }, - "status": "Precondition Required" + "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"schemas\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\"\n },\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"addressInfo\": {\n \"city\": \"\",\n \"country\": \"\",\n \"street\": \"\",\n \"zipCode\": \"\"\n },\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work_extension\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n }\n ],\n \"isMigration\": \"\",\n \"orgId\": \"\",\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}", - "code": 201, + "_postman_previewlanguage": "text", + "body": null, + "code": 410, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Created", + "header": [], + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "body": { "mode": "raw", @@ -28255,47 +28342,35 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/licenses/users" } }, - "status": "Created" + "status": "Gone" }, { "_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", @@ -28305,7 +28380,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" }, "header": [ { @@ -28313,34 +28388,78 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts" + "licenses", + "users" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "raw": "{{baseUrl}}/licenses/users" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "Text", + "body": "{\n \"orgId\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"host\"\n }\n ],\n \"pendingLicenses\": [\n \"\",\n \"\"\n ],\n \"pendingSiteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"host\"\n }\n ]\n}", + "code": 206, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Partial Content: Some licenses were successfully assigned, but others could not be assigned due to various constraints or errors. Compare the returned licenses with the requested licenses to determine which ones failed.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } - ] + }, + "raw": "{\n \"email\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"licenses\": [\n {\n \"id\": \"\",\n \"operation\": \"add\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"operation\": \"remove\",\n \"properties\": {\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n }\n ],\n \"siteUrls\": [\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"remove\"\n },\n {\n \"siteUrl\": \"\",\n \"accountType\": \"attendee\",\n \"operation\": \"add\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "licenses", + "users" + ], + "raw": "{{baseUrl}}/licenses/users" } }, - "status": "Unauthorized" + "status": "Partial Content" } ] - }, + } + ], + "name": "Licenses" + }, + { + "item": [ { - "name": "Get a Contact", + "name": "Get Meeting Qualities", "request": { - "description": "Shows details for an organization contact by ID.\nSpecify the organization ID in the `orgId` parameter in the URI, and specify the contact ID in the `contactId` parameter in the URI.\n\n**NOTE**:\nThe `orgId` used in the path for this API are the org UUIDs. They follow a xxxx-xxxx-xxxx-xxxx pattern. If you have an orgId in base64 encoded format (starting with Y2.....) you need to base64 decode the id and extract the UUID from the slug, before you use it in your API call.", + "description": "Get quality data for a meeting, by `meetingId`. Only organization administrators can retrieve meeting quality data.", "header": [ { "key": "Accept", @@ -28353,35 +28472,37 @@ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId", + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", "value": "" }, { - "description": "The contact ID.", - "key": "contactId", - "value": "" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, "response": [ { "_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", @@ -28390,26 +28511,30 @@ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", + "value": "" }, { - "description": "The contact ID.", - "key": "contactId" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, - "status": "Forbidden" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", @@ -28426,23 +28551,27 @@ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", + "value": "" }, { - "description": "The contact ID.", - "key": "contactId" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, "status": "Gateway Timeout" @@ -28450,10 +28579,10 @@ { "_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", @@ -28462,34 +28591,38 @@ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", + "value": "" }, { - "description": "The contact ID.", - "key": "contactId" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 502, "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": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -28498,34 +28631,38 @@ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", + "value": "" }, { - "description": "The contact ID.", - "key": "contactId" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, - "status": "Too Many Requests" + "status": "Bad Gateway" }, { "_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", @@ -28534,34 +28671,38 @@ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", + "value": "" }, { - "description": "The contact ID.", - "key": "contactId" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, - "status": "Internal Server Error" + "status": "Unsupported Media Type" }, { "_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", @@ -28570,34 +28711,38 @@ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", + "value": "" }, { - "description": "The contact ID.", - "key": "contactId" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, - "status": "Precondition Required" + "status": "Service Unavailable" }, { "_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", @@ -28606,34 +28751,38 @@ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", + "value": "" }, { - "description": "The contact ID.", - "key": "contactId" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, - "status": "Unsupported Media Type" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 423, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -28642,34 +28791,38 @@ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", + "value": "" }, { - "description": "The contact ID.", - "key": "contactId" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, - "status": "Bad Request" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 404, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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", @@ -28678,34 +28831,38 @@ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", + "value": "" }, { - "description": "The contact ID.", - "key": "contactId" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_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", @@ -28714,70 +28871,97 @@ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", + "value": "" }, { - "description": "The contact ID.", - "key": "contactId" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, - "status": "Conflict" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 410, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"meetingInstanceId\": \"\",\n \"webexUserName\": \"\",\n \"webexUserEmail\": \"\",\n \"joinTime\": \"\",\n \"leaveTime\": \"\",\n \"joinMeetingTime\": \"\",\n \"clientType\": \"\",\n \"clientVersion\": \"\",\n \"osType\": \"\",\n \"osVersion\": \"\",\n \"hardwareType\": \"\",\n \"speakerName\": \"\",\n \"networkType\": \"cellular\",\n \"localIP\": \"\",\n \"publicIP\": \"\",\n \"maskedLocalIP\": \"\",\n \"maskedPublicIP\": \"\",\n \"camera\": \"\",\n \"microphone\": \"\",\n \"serverRegion\": \"\",\n \"videoMeshCluster\": \"\",\n \"videoMeshServer\": \"\",\n \"participantId\": \"\",\n \"participantSessionId\": \"\",\n \"videoIn\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n }\n ],\n \"videoOut\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n }\n ],\n \"audioIn\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n }\n ],\n \"audioOut\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n }\n ],\n \"shareIn\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n }\n ],\n \"shareOut\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n }\n ],\n \"resources\": [\n {\n \"processAverageCPU\": [\n \"\",\n \"\"\n ],\n \"processMaxCPU\": [\n \"\",\n \"\"\n ],\n \"systemAverageCPU\": [\n \"\",\n \"\"\n ],\n \"systemMaxCPU\": [\n \"\",\n \"\"\n ]\n },\n {\n \"processAverageCPU\": [\n \"\",\n \"\"\n ],\n \"processMaxCPU\": [\n \"\",\n \"\"\n ],\n \"systemAverageCPU\": [\n \"\",\n \"\"\n ],\n \"systemMaxCPU\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"meetingInstanceId\": \"\",\n \"webexUserName\": \"\",\n \"webexUserEmail\": \"\",\n \"joinTime\": \"\",\n \"leaveTime\": \"\",\n \"joinMeetingTime\": \"\",\n \"clientType\": \"\",\n \"clientVersion\": \"\",\n \"osType\": \"\",\n \"osVersion\": \"\",\n \"hardwareType\": \"\",\n \"speakerName\": \"\",\n \"networkType\": \"unknown\",\n \"localIP\": \"\",\n \"publicIP\": \"\",\n \"maskedLocalIP\": \"\",\n \"maskedPublicIP\": \"\",\n \"camera\": \"\",\n \"microphone\": \"\",\n \"serverRegion\": \"\",\n \"videoMeshCluster\": \"\",\n \"videoMeshServer\": \"\",\n \"participantId\": \"\",\n \"participantSessionId\": \"\",\n \"videoIn\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n }\n ],\n \"videoOut\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n }\n ],\n \"audioIn\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n }\n ],\n \"audioOut\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n }\n ],\n \"shareIn\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"TCP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n }\n ],\n \"shareOut\": [\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n },\n {\n \"samplingInterval\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"packetLoss\": [\n \"\",\n \"\"\n ],\n \"latency\": [\n \"\",\n \"\"\n ],\n \"resolutionHeight\": [\n \"\",\n \"\"\n ],\n \"frameRate\": [\n \"\",\n \"\"\n ],\n \"mediaBitRate\": [\n \"\",\n \"\"\n ],\n \"codec\": \"\",\n \"jitter\": [\n \"\",\n \"\"\n ],\n \"transportType\": \"UDP\"\n }\n ],\n \"resources\": [\n {\n \"processAverageCPU\": [\n \"\",\n \"\"\n ],\n \"processMaxCPU\": [\n \"\",\n \"\"\n ],\n \"systemAverageCPU\": [\n \"\",\n \"\"\n ],\n \"systemMaxCPU\": [\n \"\",\n \"\"\n ]\n },\n {\n \"processAverageCPU\": [\n \"\",\n \"\"\n ],\n \"processMaxCPU\": [\n \"\",\n \"\"\n ],\n \"systemAverageCPU\": [\n \"\",\n \"\"\n ],\n \"systemMaxCPU\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Gone: The requested resource is no longer available.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", + "value": "" }, { - "description": "The contact ID.", - "key": "contactId" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, - "status": "Gone" + "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", @@ -28786,34 +28970,38 @@ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", + "value": "" }, { - "description": "The contact ID.", - "key": "contactId" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, - "status": "Service Unavailable" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 500, "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": "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", @@ -28822,34 +29010,38 @@ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", + "value": "" }, { - "description": "The contact ID.", - "key": "contactId" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_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", @@ -28858,34 +29050,38 @@ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", + "value": "" }, { - "description": "The contact ID.", - "key": "contactId" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, - "status": "Bad Gateway" + "status": "Too Many Requests" }, { "_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": "GET", @@ -28894,77 +29090,80 @@ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", + "value": "" }, { - "description": "The contact ID.", - "key": "contactId" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, - "status": "Method Not Allowed" + "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"schemas\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\"\n },\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"addressInfo\": {\n \"city\": \"\",\n \"country\": \"\",\n \"street\": \"\",\n \"zipCode\": \"\"\n },\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work_extension\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n }\n ],\n \"isMigration\": \"\",\n \"orgId\": \"\",\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 409, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" + "meeting", + "qualities" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" + "description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.", + "key": "meetingId", + "value": "" }, { - "description": "The contact ID.", - "key": "contactId" + "description": "Limit the maximum number of media sessions in the response.", + "key": "max", + "value": "100" + }, + { + "description": "Offset from the first result that you want to fetch.", + "key": "offset", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/meeting/qualities?meetingId=&max=100&offset=" } }, - "status": "OK" + "status": "Conflict" } ] - }, + } + ], + "name": "Meeting Qualities" + }, + { + "item": [ { - "name": "Update a Contact", + "name": "Create a Contact", "request": { "body": { "mode": "raw", @@ -28974,9 +29173,9 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, - "description": "Update details for contact by ID. Only an admin can update a contact.\nSpecify the organization ID in the `orgId` parameter in the URI, and specify the contact ID in the `contactId` parameter in the URI.\n\nUse the optional `groupIds` field to update the group IDs by changing the existing array. You can add or remove one or all groups. To remove all associated groups, pass an empty array in the `groupIds` field.", + "description": "Creating a new contact for a given organization requires an org admin role.\n\nAt least one of the following body parameters: `phoneNumbers`, `emails`, `sipAddresses` is required to create a new contact for source \"CH\",\n`displayName` is required to create a new contact for source \"Webex4Broadworks\".\n\nUse the optional `groupIds` field to add group IDs in an array within the organisation contact. This will become a group contact.", "header": [ { "key": "Content-Type", @@ -28987,7 +29186,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -28996,20 +29195,14 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId", "value": "" - }, - { - "description": "The contact ID.", - "key": "contactId", - "value": "" } ] } @@ -29018,10 +29211,10 @@ { "_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", @@ -29031,7 +29224,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -29039,7 +29232,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -29048,36 +29241,26 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" } ] } }, - "status": "Not Found" + "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"schemas\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\"\n },\n \"contactId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"displayName\": \"\",\n \"addressInfo\": {\n \"city\": \"\",\n \"country\": \"\",\n \"street\": \"\",\n \"zipCode\": \"\"\n },\n \"primaryContactMethod\": \"\",\n \"phoneNumbers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"emails\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"ims\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"source\": \"\",\n \"isMigration\": \"\",\n \"orgId\": \"\",\n \"groupIds\": [\n \"\",\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": { "body": { "mode": "raw", @@ -29087,19 +29270,15 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -29108,31 +29287,26 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" } ] } }, - "status": "OK" + "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", @@ -29142,7 +29316,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -29150,7 +29324,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -29159,31 +29333,26 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_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", @@ -29193,7 +29362,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -29201,7 +29370,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -29210,31 +29379,26 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" } ] } }, - "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", @@ -29244,7 +29408,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -29252,7 +29416,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -29261,31 +29425,26 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" } ] } }, - "status": "Gone" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 423, "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": "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", @@ -29295,7 +29454,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -29303,7 +29462,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -29312,31 +29471,26 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" } ] } }, - "status": "Too Many Requests" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { "body": { "mode": "raw", @@ -29346,7 +29500,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -29354,7 +29508,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -29363,31 +29517,26 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" } ] } }, - "status": "Internal Server Error" + "status": "Unsupported Media Type" }, { "_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": { "body": { "mode": "raw", @@ -29397,7 +29546,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -29405,7 +29554,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -29414,31 +29563,26 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" } ] } }, - "status": "Method Not Allowed" + "status": "Conflict" }, { "_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": { "body": { "mode": "raw", @@ -29448,7 +29592,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -29456,7 +29600,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -29465,31 +29609,26 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" } ] } }, - "status": "Service Unavailable" + "status": "Method Not Allowed" }, { "_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": { "body": { "mode": "raw", @@ -29499,7 +29638,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -29507,7 +29646,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -29516,31 +29655,26 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" } ] } }, - "status": "Conflict" + "status": "Gone" }, { "_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", @@ -29550,7 +29684,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -29558,7 +29692,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -29567,31 +29701,26 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" } ] } }, - "status": "Bad Request" + "status": "Too Many Requests" }, { "_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", @@ -29601,7 +29730,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -29609,7 +29738,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -29618,31 +29747,26 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" } ] } }, - "status": "Unsupported Media Type" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 403, "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": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "body": { "mode": "raw", @@ -29652,7 +29776,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -29660,7 +29784,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -29669,31 +29793,26 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Forbidden" }, { "_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", @@ -29703,7 +29822,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -29711,7 +29830,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -29720,31 +29839,31 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" } ] } }, - "status": "Gateway Timeout" + "status": "Precondition Required" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 403, + "_postman_previewlanguage": "json", + "body": "{\n \"schemas\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\"\n },\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"addressInfo\": {\n \"city\": \"\",\n \"country\": \"\",\n \"street\": \"\",\n \"zipCode\": \"\"\n },\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work_extension\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n }\n ],\n \"isMigration\": \"\",\n \"orgId\": \"\",\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}", + "code": 201, "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": "Created", "originalRequest": { "body": { "mode": "raw", @@ -29754,15 +29873,19 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -29771,31 +29894,26 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" } ] } }, - "status": "Forbidden" + "status": "Created" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 401, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "body": { "mode": "raw", @@ -29805,7 +29923,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"CH\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"PHONE\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -29813,7 +29931,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -29822,32 +29940,32 @@ "contacts", "organizations", ":orgId", - "contacts", - ":contactId" + "contacts" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" } ] } }, - "status": "Bad Gateway" + "status": "Unauthorized" } ] }, { - "name": "Delete a Contact", + "name": "Get a Contact", "request": { - "description": "Remove a contact from the organization. Only an admin can remove a contact.\n\nSpecify the organization ID in the `orgId` parameter in the URI, and specify the contact ID in the `contactId` parameter in the URI.", - "header": [], - "method": "DELETE", + "description": "Shows details for an organization contact by ID.\nSpecify the organization ID in the `orgId` parameter in the URI, and specify the contact ID in the `contactId` parameter in the URI.\n\n**NOTE**:\nThe `orgId` used in the path for this API are the org UUIDs. They follow a xxxx-xxxx-xxxx-xxxx pattern. If you have an orgId in base64 encoded format (starting with Y2.....) you need to base64 decode the id and extract the UUID from the slug, before you use it in your API call.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -29878,13 +29996,13 @@ { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -29909,18 +30027,18 @@ ] } }, - "status": "Bad Request" + "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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -29945,18 +30063,18 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 423, "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": "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}}" @@ -29981,18 +30099,18 @@ ] } }, - "status": "Too Many Requests" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -30017,7 +30135,7 @@ ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", @@ -30028,7 +30146,7 @@ "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}}" @@ -30055,114 +30173,6 @@ }, "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": { - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" - ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" - } - ] - } - }, - "status": "Bad Gateway" - }, - { - "_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": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" - ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" - } - ] - } - }, - "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": [ - "contacts", - "organizations", - ":orgId", - "contacts", - ":contactId" - ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId" - }, - { - "description": "The contact ID.", - "key": "contactId" - } - ] - } - }, - "status": "Service Unavailable" - }, { "_postman_previewlanguage": "text", "body": null, @@ -30172,7 +30182,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}}" @@ -30202,13 +30212,13 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 415, "cookie": [], "header": [], - "name": "No Content", + "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}}" @@ -30233,18 +30243,18 @@ ] } }, - "status": "No Content" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 400, "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 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}}" @@ -30269,18 +30279,18 @@ ] } }, - "status": "Conflict" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 401, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -30305,18 +30315,18 @@ ] } }, - "status": "Method Not Allowed" + "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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -30341,7 +30351,7 @@ ] } }, - "status": "Unsupported Media Type" + "status": "Conflict" }, { "_postman_previewlanguage": "text", @@ -30352,7 +30362,7 @@ "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -30382,13 +30392,13 @@ { "_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}}" @@ -30413,18 +30423,18 @@ ] } }, - "status": "Gateway Timeout" + "status": "Service Unavailable" }, { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -30449,70 +30459,8 @@ ] } }, - "status": "Forbidden" - } - ] - }, - { - "name": "List Contacts", - "request": { - "description": "List contacts in the organization. The default limit is `100`.\n\n`keyword` can be the value of \"displayName\", \"firstName\", \"lastName\", \"email\". An empty string of `keyword` means get all contacts.\n\n`groupIds` is a comma separated list group IDs. Results are filtered based on those group IDs.\n\nLong result sets will be split into [pages](/docs/basics#pagination).", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } - ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=&groupIds=", - "variable": [ - { - "description": "The organization ID.", - "key": "orgId", - "value": "" - } - ] - } - }, - "response": [ + "status": "Not Found" + }, { "_postman_previewlanguage": "text", "body": null, @@ -30532,35 +30480,17 @@ "organizations", ":orgId", "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { - "description": "The organization ID.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } @@ -30570,10 +30500,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 405, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -30586,50 +30516,42 @@ "organizations", ":orgId", "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { - "description": "The organization ID.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Bad Request" + "status": "Method Not Allowed" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 429, + "_postman_previewlanguage": "json", + "body": "{\n \"schemas\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\"\n },\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"addressInfo\": {\n \"city\": \"\",\n \"country\": \"\",\n \"street\": \"\",\n \"zipCode\": \"\"\n },\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work_extension\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n }\n ],\n \"isMigration\": \"\",\n \"orgId\": \"\",\n \"groupIds\": [\n \"\",\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": [ @@ -30640,51 +30562,102 @@ "organizations", ":orgId", "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { - "description": "The organization ID.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Too Many Requests" + "status": "OK" + } + ] + }, + { + "name": "Update a Contact", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, + "description": "Update details for contact by ID. Only an admin can update a contact.\nSpecify the organization ID in the `orgId` parameter in the URI, and specify the contact ID in the `contactId` parameter in the URI.\n\nUse the optional `groupIds` field to update the group IDs by changing the existing array. You can add or remove one or all groups. To remove all associated groups, pass an empty array in the `groupIds` field.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "contacts", + "organizations", + ":orgId", + "contacts", + ":contactId" + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "key": "orgId", + "value": "" + }, + { + "description": "The contact ID.", + "key": "contactId", + "value": "" + } + ] + } + }, + "response": [ { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -30694,51 +30667,57 @@ "organizations", ":orgId", "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { - "description": "The organization ID.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Conflict" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 410, + "_postman_previewlanguage": "json", + "body": "{\n \"schemas\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\"\n },\n \"contactId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"displayName\": \"\",\n \"addressInfo\": {\n \"city\": \"\",\n \"country\": \"\",\n \"street\": \"\",\n \"zipCode\": \"\"\n },\n \"primaryContactMethod\": \"\",\n \"phoneNumbers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"emails\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"ims\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"source\": \"\",\n \"isMigration\": \"\",\n \"orgId\": \"\",\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Gone: The requested resource is no longer available.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -30748,51 +30727,48 @@ "organizations", ":orgId", "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { - "description": "The organization ID.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Gone" + "status": "OK" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -30802,51 +30778,48 @@ "organizations", ":orgId", "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { - "description": "The organization ID.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Gateway Timeout" + "status": "Unauthorized" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -30856,51 +30829,48 @@ "organizations", ":orgId", "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { - "description": "The organization ID.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Service Unavailable" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 410, "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": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -30910,51 +30880,48 @@ "organizations", ":orgId", "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { - "description": "The organization ID.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Internal Server Error" + "status": "Gone" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -30964,51 +30931,48 @@ "organizations", ":orgId", "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { - "description": "The organization ID.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Too Many Requests" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -31018,51 +30982,48 @@ "organizations", ":orgId", "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { - "description": "The organization ID.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Method Not Allowed" + "status": "Internal Server Error" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -31072,61 +31033,48 @@ "organizations", ":orgId", "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { - "description": "The organization ID.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Not Found" + "status": "Method Not Allowed" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"result\": [\n {\n \"schemas\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\"\n },\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"addressInfo\": {\n \"city\": \"\",\n \"country\": \"\",\n \"street\": \"\",\n \"zipCode\": \"\"\n },\n \"primaryContactMethod\": \"EMAIL\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"qq\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"icq\",\n \"primary\": \"\"\n }\n ],\n \"isMigration\": \"\",\n \"orgId\": \"\",\n \"groupIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"schemas\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\"\n },\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"addressInfo\": {\n \"city\": \"\",\n \"country\": \"\",\n \"street\": \"\",\n \"zipCode\": \"\"\n },\n \"primaryContactMethod\": \"IMS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"qq\",\n \"primary\": \"\"\n }\n ],\n \"isMigration\": \"\",\n \"orgId\": \"\",\n \"groupIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"start\": \"\",\n \"limit\": \"\",\n \"total\": \"\"\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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -31136,51 +31084,48 @@ "organizations", ":orgId", "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { - "description": "The organization ID.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "OK" + "status": "Service Unavailable" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -31190,51 +31135,48 @@ "organizations", ":orgId", "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { - "description": "The organization ID.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Unsupported Media Type" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 400, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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 \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -31244,51 +31186,48 @@ "organizations", ":orgId", "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { - "description": "The organization ID.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Forbidden" + "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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -31298,51 +31237,48 @@ "organizations", ":orgId", "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { - "description": "The organization ID.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Unauthorized" + "status": "Unsupported Media Type" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -31352,97 +31288,30 @@ "organizations", ":orgId", "contacts", - "search" - ], - "query": [ - { - "description": "List contacts with a keyword.", - "key": "keyword", - "value": "" - }, - { - "description": "List contacts with source.", - "key": "source", - "value": "" - }, - { - "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", - "key": "limit", - "value": "" - }, - { - "description": "Filter contacts based on groups.", - "key": "groupIds", - "value": "" - } + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { - "description": "The organization ID.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Precondition Required" - } - ] - }, - { - "name": "Bulk Create or Update Contacts", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + "status": "Locked (WebDAV) (RFC 4918)" }, - "description": "Create or update contacts in bulk. Update an existing contact by specifying the contact ID in the `contactId` parameter in the request body.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - "bulk" - ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId", - "value": "" - } - ] - } - }, - "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 504, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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", @@ -31452,7 +31321,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -31460,7 +31329,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -31470,26 +31339,30 @@ "organizations", ":orgId", "contacts", - "bulk" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Forbidden" + "status": "Gateway Timeout" }, { "_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", @@ -31499,7 +31372,7 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -31507,7 +31380,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -31517,31 +31390,30 @@ "organizations", ":orgId", "contacts", - "bulk" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"contacts\": [\n {\n \"schemas\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\"\n },\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"addressInfo\": {\n \"city\": \"\",\n \"country\": \"\",\n \"street\": \"\",\n \"zipCode\": \"\"\n },\n \"primaryContactMethod\": \"IMS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"skype\",\n \"primary\": \"\"\n }\n ],\n \"isMigration\": \"\",\n \"orgId\": \"\",\n \"groupIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"schemas\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\"\n },\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"addressInfo\": {\n \"city\": \"\",\n \"country\": \"\",\n \"street\": \"\",\n \"zipCode\": \"\"\n },\n \"primaryContactMethod\": \"EMAIL\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"skype\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n }\n ],\n \"isMigration\": \"\",\n \"orgId\": \"\",\n \"groupIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"failedContacts\": [\n {\n \"id\": \"\",\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n },\n {\n \"id\": \"\",\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ],\n \"orgId\": \"\"\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": { "body": { "mode": "raw", @@ -31551,19 +31423,15 @@ "language": "json" } }, - "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + "raw": "{\n \"schemas\": \"\",\n \"source\": \"Webex4Broadworks\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\",\n \"operation\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\",\n \"operation\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"gtalk\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"yahoo\",\n \"primary\": \"\"\n }\n ],\n \"groupIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -31573,44 +31441,68 @@ "organizations", ":orgId", "contacts", - "bulk" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "OK" - }, + "status": "Bad Gateway" + } + ] + }, + { + "name": "Delete a Contact", + "request": { + "description": "Remove a contact from the organization. Only an admin can remove a contact.\n\nSpecify the organization ID in the `orgId` parameter in the URI, and specify the contact ID in the `contactId` parameter in the URI.", + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "contacts", + "organizations", + ":orgId", + "contacts", + ":contactId" + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "key": "orgId", + "value": "" + }, + { + "description": "The contact ID.", + "key": "contactId", + "value": "" + } + ] + } + }, + "response": [ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -31620,44 +31512,33 @@ "organizations", ":orgId", "contacts", - "bulk" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Unsupported Media Type" + "status": "Bad Request" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -31667,44 +31548,33 @@ "organizations", ":orgId", "contacts", - "bulk" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Internal Server Error" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -31714,44 +31584,33 @@ "organizations", ":orgId", "contacts", - "bulk" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Too Many Requests" }, { "_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 \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -31761,44 +31620,33 @@ "organizations", ":orgId", "contacts", - "bulk" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Bad Gateway" + "status": "Not Found" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -31808,44 +31656,33 @@ "organizations", ":orgId", "contacts", - "bulk" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Precondition Required" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 502, "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": "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 \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -31855,44 +31692,33 @@ "organizations", ":orgId", "contacts", - "bulk" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Too Many Requests" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 401, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -31902,44 +31728,33 @@ "organizations", ":orgId", "contacts", - "bulk" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Method Not Allowed" + "status": "Unauthorized" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -31949,44 +31764,33 @@ "organizations", ":orgId", "contacts", - "bulk" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Bad Request" + "status": "Service Unavailable" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -31996,44 +31800,33 @@ "organizations", ":orgId", "contacts", - "bulk" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Gateway Timeout" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 204, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "No Content", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -32043,18 +31836,22 @@ "organizations", ":orgId", "contacts", - "bulk" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Service Unavailable" + "status": "No Content" }, { "_postman_previewlanguage": "text", @@ -32064,23 +31861,8 @@ "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 \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -32090,15 +31872,19 @@ "organizations", ":orgId", "contacts", - "bulk" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" - } - ] + }, + { + "description": "The contact ID.", + "key": "contactId" + } + ] } }, "status": "Conflict" @@ -32106,28 +31892,13 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 405, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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 \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -32137,44 +31908,33 @@ "organizations", ":orgId", "contacts", - "bulk" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Unauthorized" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 415, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "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 \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -32184,90 +31944,33 @@ "organizations", ":orgId", "contacts", - "bulk" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Gone" - } - ] - }, - { - "name": "Bulk Delete Contacts", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + "status": "Unsupported Media Type" }, - "description": "Delete contacts in bulk.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "contacts", - "organizations", - ":orgId", - "contacts", - "bulk", - "delete" - ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", - "key": "orgId", - "value": "" - } - ] - } - }, - "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 410, "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": "Gone: The requested resource is no longer available.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -32277,45 +31980,33 @@ "organizations", ":orgId", "contacts", - "bulk", - "delete" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Gateway Timeout" + "status": "Gone" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -32325,45 +32016,33 @@ "organizations", ":orgId", "contacts", - "bulk", - "delete" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Unsupported Media Type" + "status": "Gateway Timeout" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -32373,45 +32052,95 @@ "organizations", ":orgId", "contacts", - "bulk", - "delete" + ":contactId" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId", "variable": [ { "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" + }, + { + "description": "The contact ID.", + "key": "contactId" } ] } }, - "status": "Bad Request" - }, + "status": "Forbidden" + } + ] + }, + { + "name": "List Contacts", + "request": { + "description": "List contacts in the organization. The default limit is `100`.\n\n`keyword` can be the value of \"displayName\", \"firstName\", \"lastName\", \"email\". An empty string of `keyword` means get all contacts.\n\n`groupIds` is a comma separated list group IDs. Results are filtered based on those group IDs.\n\nLong result sets will be split into [pages](/docs/basics#pagination).", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "contacts", + "organizations", + ":orgId", + "contacts", + "search" + ], + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=&groupIds=", + "variable": [ + { + "description": "The organization ID.", + "key": "orgId", + "value": "" + } + ] + } + }, + "response": [ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -32421,45 +32150,51 @@ "organizations", ":orgId", "contacts", - "bulk", - "delete" + "search" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", "variable": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "description": "The organization ID.", "key": "orgId" } ] } }, - "status": "Forbidden" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 400, "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": "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 \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -32469,45 +32204,51 @@ "organizations", ":orgId", "contacts", - "bulk", - "delete" + "search" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", "variable": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "description": "The organization ID.", "key": "orgId" } ] } }, - "status": "Too Many Requests" + "status": "Bad Request" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -32517,45 +32258,51 @@ "organizations", ":orgId", "contacts", - "bulk", - "delete" + "search" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", "variable": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "description": "The organization ID.", "key": "orgId" } ] } }, - "status": "Method Not Allowed" + "status": "Too Many Requests" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -32565,45 +32312,51 @@ "organizations", ":orgId", "contacts", - "bulk", - "delete" + "search" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", "variable": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "description": "The organization ID.", "key": "orgId" } ] } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -32613,45 +32366,51 @@ "organizations", ":orgId", "contacts", - "bulk", - "delete" + "search" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", "variable": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "description": "The organization ID.", "key": "orgId" } ] } }, - "status": "Service Unavailable" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 200, + "code": 504, "cookie": [], "header": [], - "name": "OK", + "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 \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -32661,45 +32420,51 @@ "organizations", ":orgId", "contacts", - "bulk", - "delete" + "search" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", "variable": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "description": "The organization ID.", "key": "orgId" } ] } }, - "status": "OK" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 503, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -32709,45 +32474,51 @@ "organizations", ":orgId", "contacts", - "bulk", - "delete" + "search" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", "variable": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "description": "The organization ID.", "key": "orgId" } ] } }, - "status": "Unauthorized" + "status": "Service Unavailable" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -32757,45 +32528,51 @@ "organizations", ":orgId", "contacts", - "bulk", - "delete" + "search" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", "variable": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "description": "The organization ID.", "key": "orgId" } ] } }, - "status": "Conflict" + "status": "Internal Server Error" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -32805,45 +32582,51 @@ "organizations", ":orgId", "contacts", - "bulk", - "delete" + "search" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", "variable": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "description": "The organization ID.", "key": "orgId" } ] } }, - "status": "Bad Gateway" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -32853,45 +32636,51 @@ "organizations", ":orgId", "contacts", - "bulk", - "delete" + "search" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", "variable": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "description": "The organization ID.", "key": "orgId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Method Not Allowed" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -32901,45 +32690,61 @@ "organizations", ":orgId", "contacts", - "bulk", - "delete" + "search" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", "variable": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "description": "The organization ID.", "key": "orgId" } ] } }, - "status": "Gone" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 428, + "_postman_previewlanguage": "json", + "body": "{\n \"result\": [\n {\n \"schemas\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\"\n },\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"addressInfo\": {\n \"city\": \"\",\n \"country\": \"\",\n \"street\": \"\",\n \"zipCode\": \"\"\n },\n \"primaryContactMethod\": \"EMAIL\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"qq\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"icq\",\n \"primary\": \"\"\n }\n ],\n \"isMigration\": \"\",\n \"orgId\": \"\",\n \"groupIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"schemas\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\"\n },\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"addressInfo\": {\n \"city\": \"\",\n \"country\": \"\",\n \"street\": \"\",\n \"zipCode\": \"\"\n },\n \"primaryContactMethod\": \"IMS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"qq\",\n \"primary\": \"\"\n }\n ],\n \"isMigration\": \"\",\n \"orgId\": \"\",\n \"groupIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"start\": \"\",\n \"limit\": \"\",\n \"total\": \"\"\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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" - }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -32949,45 +32754,51 @@ "organizations", ":orgId", "contacts", - "bulk", - "delete" + "search" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", "variable": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "description": "The organization ID.", "key": "orgId" } ] } }, - "status": "Precondition Required" + "status": "OK" }, { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -32997,56 +32808,48 @@ "organizations", ":orgId", "contacts", - "bulk", - "delete" + "search" ], - "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", "variable": [ { - "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "description": "The organization ID.", "key": "orgId" } ] } }, - "status": "Not Found" - } - ] - } - ], - "name": "Organization Contacts" - }, - { - "item": [ - { - "name": "List Organizations", - "request": { - "description": "List all organizations visible by your account. The results will not be [paginated](/docs/basics#pagination).", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organizations" - ], - "raw": "{{baseUrl}}/organizations" - } - }, - "response": [ + "status": "Unsupported Media Type" + }, { "_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", @@ -33055,20 +32858,52 @@ "{{baseUrl}}" ], "path": [ - "organizations" + "contacts", + "organizations", + ":orgId", + "contacts", + "search" ], - "raw": "{{baseUrl}}/organizations" + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "variable": [ + { + "description": "The organization ID.", + "key": "orgId" + } + ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_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": { "header": [], "method": "GET", @@ -33077,20 +32912,52 @@ "{{baseUrl}}" ], "path": [ - "organizations" + "contacts", + "organizations", + ":orgId", + "contacts", + "search" ], - "raw": "{{baseUrl}}/organizations" + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "variable": [ + { + "description": "The organization ID.", + "key": "orgId" + } + ] } }, - "status": "Precondition Required" + "status": "Unauthorized" }, { "_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", @@ -33099,78 +32966,243 @@ "{{baseUrl}}" ], "path": [ - "organizations" + "contacts", + "organizations", + ":orgId", + "contacts", + "search" ], - "raw": "{{baseUrl}}/organizations" + "query": [ + { + "description": "List contacts with a keyword.", + "key": "keyword", + "value": "" + }, + { + "description": "List contacts with source.", + "key": "source", + "value": "" + }, + { + "description": "Limit the maximum number of contact in the response.\n + Default: 100\n", + "key": "limit", + "value": "" + }, + { + "description": "Filter contacts based on groups.", + "key": "groupIds", + "value": "" + } + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search?keyword=&source=&limit=&groupIds=", + "variable": [ + { + "description": "The organization ID.", + "key": "orgId" + } + ] } }, - "status": "Too Many Requests" + "status": "Precondition Required" + } + ] + }, + { + "name": "Bulk Create or Update Contacts", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" }, + "description": "Create or update contacts in bulk. Update an existing contact by specifying the contact ID in the `contactId` parameter in the request body.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "contacts", + "organizations", + ":orgId", + "contacts", + "bulk" + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "key": "orgId", + "value": "" + } + ] + } + }, + "response": [ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations" + "contacts", + "organizations", + ":orgId", + "contacts", + "bulk" ], - "raw": "{{baseUrl}}/organizations" + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "key": "orgId" + } + ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations" + "contacts", + "organizations", + ":orgId", + "contacts", + "bulk" ], - "raw": "{{baseUrl}}/organizations" + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "key": "orgId" + } + ] } }, - "status": "Bad Gateway" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 409, + "_postman_previewlanguage": "json", + "body": "{\n \"contacts\": [\n {\n \"schemas\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\"\n },\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"addressInfo\": {\n \"city\": \"\",\n \"country\": \"\",\n \"street\": \"\",\n \"zipCode\": \"\"\n },\n \"primaryContactMethod\": \"IMS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"skype\",\n \"primary\": \"\"\n }\n ],\n \"isMigration\": \"\",\n \"orgId\": \"\",\n \"groupIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"schemas\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\"\n },\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"addressInfo\": {\n \"city\": \"\",\n \"country\": \"\",\n \"street\": \"\",\n \"zipCode\": \"\"\n },\n \"primaryContactMethod\": \"EMAIL\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"skype\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n }\n ],\n \"isMigration\": \"\",\n \"orgId\": \"\",\n \"groupIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"failedContacts\": [\n {\n \"id\": \"\",\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n },\n {\n \"id\": \"\",\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ],\n \"orgId\": \"\"\n}", + "code": 200, "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": "OK", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations" + "contacts", + "organizations", + ":orgId", + "contacts", + "bulk" ], - "raw": "{{baseUrl}}/organizations" + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "key": "orgId" + } + ] } }, - "status": "Conflict" + "status": "OK" }, { "_postman_previewlanguage": "text", @@ -33180,16 +33212,41 @@ "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations" + "contacts", + "organizations", + ":orgId", + "contacts", + "bulk" ], - "raw": "{{baseUrl}}/organizations" + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "key": "orgId" + } + ] } }, "status": "Unsupported Media Type" @@ -33197,122 +33254,237 @@ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations" + "contacts", + "organizations", + ":orgId", + "contacts", + "bulk" ], - "raw": "{{baseUrl}}/organizations" + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "key": "orgId" + } + ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations" + "contacts", + "organizations", + ":orgId", + "contacts", + "bulk" ], - "raw": "{{baseUrl}}/organizations" + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "key": "orgId" + } + ] } }, - "status": "Gone" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations" + "contacts", + "organizations", + ":orgId", + "contacts", + "bulk" ], - "raw": "{{baseUrl}}/organizations" + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "key": "orgId" + } + ] } }, - "status": "Internal Server Error" + "status": "Bad Gateway" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"created\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 428, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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 \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations" + "contacts", + "organizations", + ":orgId", + "contacts", + "bulk" ], - "raw": "{{baseUrl}}/organizations" + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "key": "orgId" + } + ] } }, - "status": "OK" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 429, "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": "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": [ - "organizations" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/organizations" + "path": [ + "contacts", + "organizations", + ":orgId", + "contacts", + "bulk" + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "key": "orgId" + } + ] } }, - "status": "Gateway Timeout" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", @@ -33322,16 +33494,41 @@ "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations" + "contacts", + "organizations", + ":orgId", + "contacts", + "bulk" ], - "raw": "{{baseUrl}}/organizations" + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "key": "orgId" + } + ] } }, "status": "Method Not Allowed" @@ -33344,16 +33541,41 @@ "header": [], "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 \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations" + "contacts", + "organizations", + ":orgId", + "contacts", + "bulk" ], - "raw": "{{baseUrl}}/organizations" + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "key": "orgId" + } + ] } }, "status": "Bad Request" @@ -33361,24 +33583,49 @@ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations" + "contacts", + "organizations", + ":orgId", + "contacts", + "bulk" ], - "raw": "{{baseUrl}}/organizations" + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "key": "orgId" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -33388,109 +33635,91 @@ "header": [], "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organizations" - ], - "raw": "{{baseUrl}}/organizations" - } - }, - "status": "Service Unavailable" - } - ] - }, - { - "name": "Get Organization Details", - "request": { - "description": "Shows details for an organization, by ID.\n\nSpecify the org ID in the `orgId` parameter in the URI.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organizations", - ":orgId" - ], - "raw": "{{baseUrl}}/organizations/:orgId", - "variable": [ - { - "description": "The unique identifier for the organization.", - "key": "orgId", - "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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Unsupported Media Type" + "status": "Service Unavailable" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Method Not Allowed" + "status": "Conflict" }, { "_postman_previewlanguage": "text", @@ -33500,20 +33729,38 @@ "header": [], "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] @@ -33524,32 +33771,96 @@ { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"contacts\": [\n {\n \"source\": \"CH\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"personal-room\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"msn\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"microsoft-sip-uri\",\n \"primary\": \"\"\n }\n ]\n },\n {\n \"source\": \"Webex4Broadworks\",\n \"contactId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"companyName\": \"\",\n \"title\": \"\",\n \"address\": \"\",\n \"avatarURL\": \"\",\n \"primaryContactMethod\": \"SIPADDRESS\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"primary\": \"\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"primary\": \"\"\n }\n ],\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"cloud-calling\",\n \"primary\": \"\"\n }\n ],\n \"ims\": [\n {\n \"value\": \"\",\n \"type\": \"xmpp-fed-jid\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"aim\",\n \"primary\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Too Many Requests" + "status": "Gone" + } + ] + }, + { + "name": "Bulk Delete Contacts", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" }, + "description": "Delete contacts in bulk.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "contacts", + "organizations", + ":orgId", + "contacts", + "bulk", + "delete" + ], + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", + "key": "orgId", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "text", "body": null, @@ -33558,20 +33869,39 @@ "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk", + "delete" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] @@ -33582,529 +33912,814 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 415, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "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 \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk", + "delete" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Gone" + "status": "Unsupported Media Type" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk", + "delete" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Not Found" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 403, "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": "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 \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk", + "delete" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "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", - "url": { - "host": [ - "{{baseUrl}}" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk", + "delete" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Precondition Required" + "status": "Too Many Requests" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk", + "delete" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Conflict" + "status": "Method Not Allowed" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk", + "delete" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk", + "delete" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Bad Gateway" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 200, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "OK", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk", + "delete" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Bad Request" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 401, "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": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk", + "delete" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"displayName\": \"\",\n \"created\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 409, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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 \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk", + "delete" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "OK" + "status": "Conflict" }, { "_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 \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk", + "delete" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Forbidden" - } - ] - }, - { - "name": "Delete Organization", - "request": { - "description": "Deletes an organization, by ID. It may take up to 10 minutes for the organization to be deleted after the response is returned.\n

\nSpecify the org ID in the `orgId` parameter in the URI.\n\n
Deleting your organization permanently deletes all of the information associated with your organization and is irreversible.
\n\nDeleting an Organization may fail with a HTTP 409 Conflict response and encounter one or more of the errors described below. Resolve these conditions to allow the delete to succeed.\n

\n\n+ Org cannot be deleted as it has Linked sites.\n\n+ Org cannot be deleted as it has active subscriptions or licenses.\n\n+ Org cannot be deleted as [Directory Synchronization](https://developer.webex.com/docs/api/v1/broadworks-enterprises/get-directory-sync-status-for-an-enterprise) is enabled.\n\n+ Org cannot be deleted as it has more than 1 user.\n\n+ Org cannot be deleted as it has more than 1 managed by relationship.\n\n+ Org cannot be deleted as it has managed orgs.\n\n
\nWhen deleting a Webex for BroadWorks Organization with BroadWorks Directory Synchronization enabled, a prerequisite is to disable BroadWorks Directory Synchronization for the given Organization. Refer to the [Organization Deletion](https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide#organization-deletion) section of the [Webex for BroadWorks](/docs/api/guides/webex-for-broadworks-developers-guide) guide for more information.\n
", - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organizations", - ":orgId" - ], - "raw": "{{baseUrl}}/organizations/:orgId", - "variable": [ - { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" - } - ] - } - }, - "response": [ + "status": "Bad Gateway" + }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk", + "delete" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Precondition Required" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk", + "delete" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Service Unavailable" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 428, "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": "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 \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk", + "delete" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Internal Server Error" + "status": "Precondition Required" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": \"\",\n \"objectIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "contacts", "organizations", - ":orgId" + ":orgId", + "contacts", + "bulk", + "delete" ], - "raw": "{{baseUrl}}/organizations/:orgId", + "raw": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete", "variable": [ { - "description": "The unique identifier for the organization.", + "description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.", "key": "orgId" } ] } }, - "status": "Forbidden" - }, + "status": "Not Found" + } + ] + } + ], + "name": "Organization Contacts" + }, + { + "item": [ + { + "name": "List Organizations", + "request": { + "description": "List all organizations visible by your account. The results will not be [paginated](/docs/basics#pagination).", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organizations" + ], + "raw": "{{baseUrl}}/organizations" + } + }, + "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 404, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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}}" ], "path": [ - "organizations", - ":orgId" + "organizations" ], - "raw": "{{baseUrl}}/organizations/:orgId", - "variable": [ - { - "description": "The unique identifier for the organization.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/organizations" } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations", - ":orgId" + "organizations" ], - "raw": "{{baseUrl}}/organizations/:orgId", - "variable": [ - { - "description": "The unique identifier for the organization.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/organizations" + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organizations" + ], + "raw": "{{baseUrl}}/organizations" } }, "status": "Too Many Requests" @@ -34112,89 +34727,68 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 401, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations", - ":orgId" + "organizations" ], - "raw": "{{baseUrl}}/organizations/:orgId", - "variable": [ - { - "description": "The unique identifier for the organization.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/organizations" } }, - "status": "Gone" + "status": "Unauthorized" }, { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations", - ":orgId" + "organizations" ], - "raw": "{{baseUrl}}/organizations/:orgId", - "variable": [ - { - "description": "The unique identifier for the organization.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/organizations" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Gateway" }, { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations", - ":orgId" + "organizations" ], - "raw": "{{baseUrl}}/organizations/:orgId", - "variable": [ - { - "description": "The unique identifier for the organization.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/organizations" } }, - "status": "No Content" + "status": "Conflict" }, { "_postman_previewlanguage": "text", @@ -34205,22 +34799,15 @@ "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}}" ], "path": [ - "organizations", - ":orgId" + "organizations" ], - "raw": "{{baseUrl}}/organizations/:orgId", - "variable": [ - { - "description": "The unique identifier for the organization.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/organizations" } }, "status": "Unsupported Media Type" @@ -34228,89 +34815,100 @@ { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations", - ":orgId" + "organizations" ], - "raw": "{{baseUrl}}/organizations/:orgId", - "variable": [ - { - "description": "The unique identifier for the organization.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/organizations" } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations", - ":orgId" + "organizations" ], - "raw": "{{baseUrl}}/organizations/:orgId", - "variable": [ - { - "description": "The unique identifier for the organization.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/organizations" } }, - "status": "Conflict" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 500, "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": "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}}" ], "path": [ - "organizations", - ":orgId" + "organizations" ], - "raw": "{{baseUrl}}/organizations/:orgId", - "variable": [ - { - "description": "The unique identifier for the organization.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/organizations" } }, - "status": "Not Found" + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"created\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"created\": \"\"\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": [ + "organizations" + ], + "raw": "{{baseUrl}}/organizations" + } + }, + "status": "OK" }, { "_postman_previewlanguage": "text", @@ -34321,22 +34919,15 @@ "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}}" ], "path": [ - "organizations", - ":orgId" + "organizations" ], - "raw": "{{baseUrl}}/organizations/:orgId", - "variable": [ - { - "description": "The unique identifier for the organization.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/organizations" } }, "status": "Gateway Timeout" @@ -34350,22 +34941,15 @@ "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}}" ], "path": [ - "organizations", - ":orgId" + "organizations" ], - "raw": "{{baseUrl}}/organizations/:orgId", - "variable": [ - { - "description": "The unique identifier for the organization.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/organizations" } }, "status": "Method Not Allowed" @@ -34373,43 +34957,75 @@ { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organizations", - ":orgId" + "organizations" ], - "raw": "{{baseUrl}}/organizations/:orgId", - "variable": [ - { - "description": "The unique identifier for the organization.", - "key": "orgId" - } - ] + "raw": "{{baseUrl}}/organizations" } }, - "status": "Bad Gateway" + "status": "Bad Request" + }, + { + "_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": [ + "organizations" + ], + "raw": "{{baseUrl}}/organizations" + } + }, + "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": [ + "organizations" + ], + "raw": "{{baseUrl}}/organizations" + } + }, + "status": "Service Unavailable" } ] - } - ], - "name": "Organizations" - }, - { - "item": [ + }, { - "name": "Get all customers managed by a partner admin", + "name": "Get Organization Details", "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. 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.", + "description": "Shows details for an organization, by ID.\n\nSpecify the org ID in the `orgId` parameter in the URI.", "header": [ { "key": "Accept", @@ -34422,27 +35038,27 @@ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", + "description": "The unique identifier for the organization.", + "key": "orgId", "value": "" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 415, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -34451,28 +35067,27 @@ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", - "value": "" + "description": "The unique identifier for the organization.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, - "status": "Bad Request" + "status": "Unsupported Media Type" }, { "_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": "GET", @@ -34481,28 +35096,27 @@ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", - "value": "" + "description": "The unique identifier for the organization.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Method Not Allowed" }, { "_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": { "header": [], "method": "GET", @@ -34511,28 +35125,27 @@ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", - "value": "" + "description": "The unique identifier for the organization.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, - "status": "Precondition Required" + "status": "Unauthorized" }, { "_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": { "header": [], "method": "GET", @@ -34541,28 +35154,27 @@ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", - "value": "" + "description": "The unique identifier for the organization.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_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": { "header": [], "method": "GET", @@ -34571,20 +35183,19 @@ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", - "value": "" + "description": "The unique identifier for the organization.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, - "status": "Unsupported Media Type" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -34601,17 +35212,16 @@ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", - "value": "" + "description": "The unique identifier for the organization.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, "status": "Gone" @@ -34619,10 +35229,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 404, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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", @@ -34631,68 +35241,56 @@ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", - "value": "" + "description": "The unique identifier for the organization.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"orgId\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"role\": \"\"\n }\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": [ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", - "value": "" + "description": "The unique identifier for the organization.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, - "status": "OK" + "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": { "header": [], "method": "GET", @@ -34701,28 +35299,27 @@ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", - "value": "" + "description": "The unique identifier for the organization.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, - "status": "Not Found" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 409, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. 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": "GET", @@ -34731,28 +35328,27 @@ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", - "value": "" + "description": "The unique identifier for the organization.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, - "status": "Service Unavailable" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 503, "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": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -34761,28 +35357,27 @@ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", - "value": "" + "description": "The unique identifier for the organization.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, - "status": "Too Many Requests" + "status": "Service Unavailable" }, { "_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", @@ -34791,28 +35386,27 @@ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", - "value": "" + "description": "The unique identifier for the organization.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, - "status": "Internal Server Error" + "status": "Bad Gateway" }, { "_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": "GET", @@ -34821,28 +35415,27 @@ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", - "value": "" + "description": "The unique identifier for the organization.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, - "status": "Method Not Allowed" + "status": "Bad Request" }, { "_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": { "header": [], "method": "GET", @@ -34851,58 +35444,66 @@ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", - "value": "" + "description": "The unique identifier for the organization.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, - "status": "Bad Gateway" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 409, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"displayName\": \"\",\n \"created\": \"\"\n}", + "code": 200, "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": "OK", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", - "value": "" + "description": "The unique identifier for the organization.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, - "status": "Conflict" + "status": "OK" }, { "_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", @@ -34911,48 +35512,40 @@ "{{baseUrl}}" ], "path": [ - "partner", - "organizations" + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/organizations/:orgId", + "variable": [ { - "description": "List customer orgs associated with this person ID.", - "key": "managedBy", - "value": "" + "description": "The unique identifier for the organization.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/organizations?managedBy=" + ] } }, - "status": "Gateway Timeout" + "status": "Forbidden" } ] }, { - "name": "Get all partner admins assigned to a customer", + "name": "Delete Organization", "request": { - "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", - "value": "application/json" - } - ], - "method": "GET", + "description": "Deletes an organization, by ID. It may take up to 10 minutes for the organization to be deleted after the response is returned.\n

\nSpecify the org ID in the `orgId` parameter in the URI.\n\n
Deleting your organization permanently deletes all of the information associated with your organization and is irreversible.
\n\nDeleting an Organization may fail with a HTTP 409 Conflict response and encounter one or more of the errors described below. Resolve these conditions to allow the delete to succeed.\n

\n\n+ Org cannot be deleted as it has Linked sites.\n\n+ Org cannot be deleted as it has active subscriptions or licenses.\n\n+ Org cannot be deleted as [Directory Synchronization](https://developer.webex.com/docs/api/v1/broadworks-enterprises/get-directory-sync-status-for-an-enterprise) is enabled.\n\n+ Org cannot be deleted as it has more than 1 user.\n\n+ Org cannot be deleted as it has more than 1 managed by relationship.\n\n+ Org cannot be deleted as it has managed orgs.\n\n
\nWhen deleting a Webex for BroadWorks Organization with BroadWorks Directory Synchronization enabled, a prerequisite is to disable BroadWorks Directory Synchronization for the given Organization. Refer to the [Organization Deletion](https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide#organization-deletion) section of the [Webex for BroadWorks](/docs/api/guides/webex-for-broadworks-developers-guide) guide for more information.\n
", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId", "value": "" } @@ -34961,169 +35554,149 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"roleInCustomerOrg\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"roleInCustomerOrg\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 428, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId" } ] } }, - "status": "OK" + "status": "Precondition Required" }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId" } ] } }, - "status": "Forbidden" + "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": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId" } ] } }, - "status": "Precondition Required" + "status": "Internal Server Error" }, { "_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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId" } ] } }, - "status": "Method Not Allowed" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 401, "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": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -35134,21 +35707,19 @@ "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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId" } ] @@ -35159,385 +35730,359 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 410, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId" } ] } }, - "status": "Bad Gateway" + "status": "Gone" }, { "_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": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId" } ] } }, - "status": "Gateway Timeout" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 204, "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": "No Content", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId" } ] } }, - "status": "Not Found" + "status": "No Content" }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId" } ] } }, - "status": "Conflict" + "status": "Unsupported Media Type" }, { "_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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId" } ] } }, - "status": "Service Unavailable" + "status": "Bad Request" }, { "_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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId" } ] } }, - "status": "Unsupported Media Type" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 404, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId" } ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 405, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId" } ] } }, - "status": "Bad Request" + "status": "Method Not Allowed" }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", "organizations", - ":orgId", - "partnerAdmins" + ":orgId" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", + "raw": "{{baseUrl}}/organizations/:orgId", "variable": [ { - "description": "List partner admins associated with this customer org ID.", + "description": "The unique identifier for the organization.", "key": "orgId" } ] } }, - "status": "Gone" + "status": "Bad Gateway" } ] - }, + } + ], + "name": "Organizations" + }, + { + "item": [ { - "name": "Assign partner admin to a customer", + "name": "Get all customers managed by a partner admin", "request": { - "description": "Assign a specific Partner Admin to a customer organization. The partner admin is a user that has the Partner Administrator role.\nOther partner roles, such as Partner Full Administrator are not applicable for this API, since this role manages all customer organizations.\n\nThis API can be used b a Partner Full Admin.\n\nSpecify the `orgId` and the `personId` in the path param.", - "header": [], - "method": "POST", + "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", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId", - "value": "" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId", + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" } }, "response": [ { "_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": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", + "value": "" } - ] - } + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" + } }, - "status": "Not Found" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", @@ -35548,30 +36093,23 @@ "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": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" } }, "status": "Locked (WebDAV) (RFC 4918)" @@ -35579,529 +36117,446 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 428, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" } }, - "status": "Bad Gateway" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 403, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" } }, - "status": "Service Unavailable" + "status": "Forbidden" }, { "_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": { "header": [], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" } }, - "status": "Method Not Allowed" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 200, + "code": 410, "cookie": [], "header": [], - "name": "OK", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" } }, - "status": "OK" + "status": "Gone" }, { "_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": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 415, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"orgId\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"role\": \"\"\n }\n ]\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": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" } }, - "status": "Unsupported Media Type" + "status": "OK" }, { "_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": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" } }, - "status": "Conflict" + "status": "Not Found" }, { "_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": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" } }, - "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": { "header": [], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" } }, - "status": "Bad Request" + "status": "Too Many Requests" }, { "_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": { "header": [], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_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": { "header": [], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" } }, - "status": "Internal Server Error" + "status": "Method Not Allowed" }, { "_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": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" } }, - "status": "Gone" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 409, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" } }, - "status": "Forbidden" + "status": "Conflict" }, { "_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": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "organizations", - ":orgId", - "partnerAdmin", - ":personId", - "assign" + "organizations" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", - "variable": [ - { - "description": "The ID of the customer organization.", - "key": "orgId" - }, + "query": [ { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" + "description": "List customer orgs associated with this person ID.", + "key": "managedBy", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/organizations?managedBy=" } }, - "status": "Precondition Required" + "status": "Gateway Timeout" } ] }, { - "name": "Unassign partner admin from a customer", + "name": "Get all partner admins assigned to 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. 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", + "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", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -36110,36 +36565,39 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId", "value": "" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId", - "value": "" } ] } }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 504, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"roleInCustomerOrg\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"roleInCustomerOrg\": \"\"\n }\n ]\n}", + "code": 200, "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": "OK", "originalRequest": { - "header": [], - "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -36148,35 +36606,29 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" } ] } }, - "status": "Gateway Timeout" + "status": "OK" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -36185,24 +36637,18 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" } ] } }, - "status": "Gone" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -36213,7 +36659,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}}" @@ -36222,19 +36668,13 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" } ] } @@ -36244,13 +36684,13 @@ { "_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", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -36259,35 +36699,29 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Method Not Allowed" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -36296,35 +36730,29 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" } ] } }, - "status": "Unsupported Media Type" + "status": "Internal Server Error" }, { "_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", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -36333,35 +36761,29 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" } ] } }, - "status": "Bad Gateway" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 200, + "code": 502, "cookie": [], "header": [], - "name": "OK", + "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}}" @@ -36370,35 +36792,29 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" } ] } }, - "status": "OK" + "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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -36407,35 +36823,29 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" } ] } }, - "status": "Internal Server Error" + "status": "Gateway Timeout" }, { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -36444,35 +36854,29 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" } ] } }, - "status": "Forbidden" + "status": "Not Found" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -36481,35 +36885,29 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" } ] } }, - "status": "Method Not Allowed" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 503, "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": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -36518,35 +36916,29 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" } ] } }, - "status": "Too Many Requests" + "status": "Service Unavailable" }, { "_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}}" @@ -36555,35 +36947,29 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" } ] } }, - "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}}" @@ -36592,35 +36978,29 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" } ] } }, - "status": "Bad Request" + "status": "Unauthorized" }, { "_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", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -36629,35 +37009,29 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" } ] } }, - "status": "Service Unavailable" + "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}}" @@ -36666,35 +37040,29 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" } ] } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -36703,33 +37071,27 @@ "partner", "organizations", ":orgId", - "partnerAdmin", - ":personId", - "unassign" + "partnerAdmins" ], - "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins", "variable": [ { - "description": "The ID of the customer organization.", + "description": "List partner admins associated with this customer org ID.", "key": "orgId" - }, - { - "description": "User ID of the partner admin in the partners org.", - "key": "personId" } ] } }, - "status": "Conflict" + "status": "Gone" } ] }, { - "name": "Revoke all partner admin roles for a given person ID", + "name": "Assign partner admin to a customer", "request": { - "description": "Revoke all partner administrator roles from a user, thereby revoking access to Partner Hub and all managed customer organizations.\nThis action does not grant or revoke Control Hub administrator roles (e.g. Full Administrator, User and Device Administrator, etc.).\nThis API can be used by Partner Full Admin.\nSpecify the `personId` in the path param.", + "description": "Assign a specific Partner Admin to a customer organization. The partner admin is a user that has the Partner Administrator role.\nOther partner roles, such as Partner Full Administrator are not applicable for this API, since this role manages all customer organizations.\n\nThis API can be used b a Partner Full Admin.\n\nSpecify the `orgId` and the `personId` in the path param.", "header": [], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -36737,13 +37099,20 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId", + "value": "" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId", "value": "" } @@ -36754,13 +37123,13 @@ { "_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": { "header": [], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -36768,30 +37137,36 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId" } ] } }, - "status": "Precondition Required" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 423, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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": "POST", "url": { "host": [ "{{baseUrl}}" @@ -36799,19 +37174,25 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId" } ] } }, - "status": "Forbidden" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", @@ -36822,7 +37203,7 @@ "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": "POST", "url": { "host": [ "{{baseUrl}}" @@ -36830,13 +37211,19 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId" } ] @@ -36847,13 +37234,13 @@ { "_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": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -36861,30 +37248,36 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId" } ] } }, - "status": "Not Found" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 405, "cookie": [], "header": [], - "name": "No Content", + "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": "POST", "url": { "host": [ "{{baseUrl}}" @@ -36892,30 +37285,36 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId" } ] } }, - "status": "No Content" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "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).", + "name": "OK", "originalRequest": { "header": [], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -36923,30 +37322,36 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 429, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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": "POST", "url": { "host": [ "{{baseUrl}}" @@ -36954,30 +37359,36 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_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": "POST", "url": { "host": [ "{{baseUrl}}" @@ -36985,30 +37396,36 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId" } ] } }, - "status": "Too Many Requests" + "status": "Unsupported Media Type" }, { "_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": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -37016,30 +37433,36 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId" } ] } }, - "status": "Method Not Allowed" + "status": "Conflict" }, { "_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": { "header": [], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -37047,19 +37470,25 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId" } ] } }, - "status": "Conflict" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -37070,7 +37499,7 @@ "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -37078,13 +37507,19 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId" } ] @@ -37095,13 +37530,13 @@ { "_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": "POST", "url": { "host": [ "{{baseUrl}}" @@ -37109,30 +37544,36 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId" } ] } }, - "status": "Unsupported Media Type" + "status": "Unauthorized" }, { "_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": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -37140,30 +37581,36 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId" } ] } }, - "status": "Gone" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 410, "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": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -37171,30 +37618,36 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId" } ] } }, - "status": "Gateway Timeout" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 403, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -37202,30 +37655,36 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId" } ] } }, - "status": "Service Unavailable" + "status": "Forbidden" }, { "_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": { "header": [], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -37233,136 +37692,135 @@ "path": [ "partner", "organizations", + ":orgId", "partnerAdmin", - ":personId" + ":personId", + "assign" ], - "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign", "variable": [ { - "description": "ID of the user whose partner roles needs to be revoked.", + "description": "The ID of the customer organization.", + "key": "orgId" + }, + { + "description": "User ID of the partner admin in the partners org.", "key": "personId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Precondition Required" } ] - } - ], - "name": "Partner Administrators" - }, - { - "item": [ + }, { - "name": "List Reports", + "name": "Unassign partner admin from a customer", "request": { - "description": "Lists all reports previously generated from a given region. Use query parameters to filter the response. The parameters are optional.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_read` and `identity:people_read` scopes.\n\n
CSV reports for Webex suite services are only supported for organizations based in one region per API request. Organizations based in a different region will require a separate request with region specified.
\n\n
When no region is specified, the request defaults to Partner organization's home region.
\n\n
Reports are usually provided in zip format. A content-header application/zip or application/octet-stream does indicate the zip format. There is usually no .zip file extension.
", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "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": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", + "description": "The ID of the customer organization.", + "key": "orgId", "value": "" }, { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", + "description": "User ID of the partner admin in the partners org.", + "key": "personId", "value": "" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" + ] } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 504, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method 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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" + "description": "The ID of the customer organization.", + "key": "orgId" }, { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, + "description": "User ID of the partner admin in the partners org.", + "key": "personId" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_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": [ + "partner", + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" + ], + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", - "value": "" + "description": "The ID of the customer organization.", + "key": "orgId" }, { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "User ID of the partner admin in the partners org.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Method Not Allowed" + "status": "Gone" }, { "_postman_previewlanguage": "text", @@ -37373,48 +37831,30 @@ "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", - "value": "" + "description": "The ID of the customer organization.", + "key": "orgId" }, { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "User ID of the partner admin in the partners org.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" + ] } }, "status": "Precondition Required" @@ -37422,1242 +37862,822 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 423, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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": [ "partner", - "reports" + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", - "value": "" + "description": "The ID of the customer organization.", + "key": "orgId" }, { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "User ID of the partner admin in the partners org.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Bad Request" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", - "value": "" + "description": "The ID of the customer organization.", + "key": "orgId" }, { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "User ID of the partner admin in the partners org.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Gateway Timeout" + "status": "Unsupported Media Type" }, { "_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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", - "value": "" + "description": "The ID of the customer organization.", + "key": "orgId" }, { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "User ID of the partner admin in the partners org.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Conflict" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 200, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "OK", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", - "value": "" + "description": "The ID of the customer organization.", + "key": "orgId" }, { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "User ID of the partner admin in the partners org.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Forbidden" + "status": "OK" }, { "_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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", - "value": "" + "description": "The ID of the customer organization.", + "key": "orgId" }, { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "User ID of the partner admin in the partners org.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 403, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", - "value": "" + "description": "The ID of the customer organization.", + "key": "orgId" }, { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "User ID of the partner admin in the partners org.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Service Unavailable" + "status": "Forbidden" }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", - "value": "" + "description": "The ID of the customer organization.", + "key": "orgId" }, { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "User ID of the partner admin in the partners org.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Not Found" + "status": "Method Not Allowed" }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", - "value": "" + "description": "The ID of the customer organization.", + "key": "orgId" }, { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "User ID of the partner admin in the partners org.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Too Many Requests" }, { "_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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", - "value": "" + "description": "The ID of the customer organization.", + "key": "orgId" }, { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "User ID of the partner admin in the partners org.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Bad Gateway" + "status": "Not Found" }, { "_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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", - "value": "" + "description": "The ID of the customer organization.", + "key": "orgId" }, { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "User ID of the partner admin in the partners org.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Unsupported Media Type" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 503, "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": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", - "value": "" + "description": "The ID of the customer organization.", + "key": "orgId" }, { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "User ID of the partner admin in the partners org.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Too Many Requests" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 401, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", - "value": "" + "description": "The ID of the customer organization.", + "key": "orgId" }, { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "User ID of the partner admin in the partners org.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Gone" + "status": "Unauthorized" }, { "_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": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + ":orgId", + "partnerAdmin", + ":personId", + "unassign" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign", + "variable": [ { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", - "value": "" + "description": "The ID of the customer organization.", + "key": "orgId" }, { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "User ID of the partner admin in the partners org.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Internal Server Error" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"Report Attributes\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"created\": \"\",\n \"createdBy\": \"\",\n \"scheduledFrom\": \"\",\n \"status\": \"\",\n \"downloadURL\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"created\": \"\",\n \"createdBy\": \"\",\n \"scheduledFrom\": \"\",\n \"status\": \"\",\n \"downloadURL\": \"\"\n }\n ]\n}", - "code": 200, - "cookie": [], - "header": [ + "status": "Conflict" + } + ] + }, + { + "name": "Revoke all partner admin roles for a given person ID", + "request": { + "description": "Revoke all partner administrator roles from a user, thereby revoking access to Partner Hub and all managed customer organizations.\nThis action does not grant or revoke Control Hub administrator roles (e.g. Full Administrator, User and Device Administrator, etc.).\nThis API can be used by Partner Full Admin.\nSpecify the `personId` in the path param.", + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "partner", + "organizations", + "partnerAdmin", + ":personId" + ], + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "key": "Content-Type", - "value": "application/json" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId", + "value": "" } - ], - "name": "OK", + ] + } + }, + "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": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + "partnerAdmin", + ":personId" ], - "query": [ - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - }, - { - "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", - "key": "regionId", - "value": "" - }, - { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" - } - }, - "status": "OK" - } - ] - }, - { - "name": "Create a Report", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + ] } }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + "status": "Precondition Required" }, - "description": "Create a new report. A new report can be created using `templateId` available from the _List Report Templates_ API. For each `templateId`, there are a set of validation rules that need to be followed.\n\nThe `templateId` parameter is a number. However, it is a limitation of developer.webex.com platform that it is passed as a string when you try to test the API from here.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_write` and `identity:people_read` scopes.\n\n**Notes**:\n\n
CSV reports for Webex suite services are only created for organizations in the specified region. Organizations based in a different region will require a separate request with region specified.
\n\n
When no region is specified, the request defaults to Partner organization's home region. A request against a region where there are no organizations will return blank CSV files.
", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "partner", - "reports" - ], - "query": [ - { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" - } - }, - "response": [ { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + "partnerAdmin", + ":personId" ], - "query": [ + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Unsupported Media Type" + "status": "Forbidden" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + "partnerAdmin", + ":personId" ], - "query": [ + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Gone" + "status": "Bad Gateway" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + "partnerAdmin", + ":personId" ], - "query": [ + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Precondition Required" + "status": "Not Found" }, { "_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", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + "partnerAdmin", + ":personId" ], - "query": [ + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Bad Gateway" + "status": "No Content" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + "partnerAdmin", + ":personId" ], - "query": [ + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Conflict" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 401, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + "partnerAdmin", + ":personId" ], - "query": [ + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Method Not Allowed" + "status": "Unauthorized" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + "partnerAdmin", + ":personId" ], - "query": [ + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + "partnerAdmin", + ":personId" ], - "query": [ + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Service Unavailable" + "status": "Method Not Allowed" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"reportId\": \"\",\n \"createdTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 409, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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 \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + "partnerAdmin", + ":personId" ], - "query": [ + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "OK" + "status": "Conflict" }, { "_postman_previewlanguage": "text", @@ -38667,39 +38687,25 @@ "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 \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + "partnerAdmin", + ":personId" ], - "query": [ + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" + ] } }, "status": "Bad Request" @@ -38707,279 +38713,169 @@ { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + "partnerAdmin", + ":personId" ], - "query": [ + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" - } - }, - "status": "Internal Server Error" - }, - { - "_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 \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "partner", - "reports" - ], - "query": [ - { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Forbidden" + "status": "Unsupported Media Type" }, { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + "partnerAdmin", + ":personId" ], - "query": [ + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Unauthorized" + "status": "Gone" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + "partnerAdmin", + ":personId" ], - "query": [ + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 503, "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": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + "partnerAdmin", + ":personId" ], - "query": [ + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Too Many Requests" + "status": "Service Unavailable" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports" + "organizations", + "partnerAdmin", + ":personId" ], - "query": [ + "raw": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId", + "variable": [ { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "description": "ID of the user whose partner roles needs to be revoked.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" + ] } }, - "status": "Gateway Timeout" + "status": "Locked (WebDAV) (RFC 4918)" } ] - }, + } + ], + "name": "Partner Administrators" + }, + { + "item": [ { - "name": "Get Report Details", + "name": "List Reports", "request": { - "description": "Shows details for a report by report ID.\n\nSpecify the report ID in the `reportId` parameter in the URI.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_read` and `identity:people_read` scopes.\n\n**Notes**:\n\n
Reports are usually provided in zip format. A content-header application/zip or application/octet-stream does indicate the zip format. There is usually no .zip file extension.
", + "description": "Lists all reports previously generated from a given region. Use query parameters to filter the response. The parameters are optional.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_read` and `identity:people_read` scopes.\n\n
CSV reports for Webex suite services are only supported for organizations based in one region per API request. Organizations based in a different region will require a separate request with region specified.
\n\n
When no region is specified, the request defaults to Partner organization's home region.
\n\n
Reports are usually provided in zip format. A content-header application/zip or application/octet-stream does indicate the zip format. There is usually no .zip file extension.
", "header": [ { "key": "Accept", @@ -38993,34 +38889,51 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId", - "value": "" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, "response": [ { "_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", @@ -39030,34 +38943,52 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, - "status": "Conflict" + "status": "Method Not Allowed" }, { "_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": { "header": [], "method": "GET", @@ -39067,34 +38998,52 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, - "status": "Not Found" + "status": "Precondition Required" }, { "_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", @@ -39104,34 +39053,52 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 504, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -39141,34 +39108,52 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, - "status": "Bad Request" + "status": "Gateway Timeout" }, { "_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": "GET", @@ -39178,34 +39163,52 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, - "status": "Bad Gateway" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 403, "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": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], "method": "GET", @@ -39215,34 +39218,52 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 401, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], "method": "GET", @@ -39252,34 +39273,52 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, - "status": "Method Not Allowed" + "status": "Unauthorized" }, { "_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", @@ -39289,34 +39328,52 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, - "status": "Gone" + "status": "Service Unavailable" }, { "_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", @@ -39326,34 +39383,52 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, - "status": "Service Unavailable" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 423, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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", @@ -39363,34 +39438,52 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, - "status": "Forbidden" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 502, "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": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -39400,34 +39493,52 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, - "status": "Too Many Requests" + "status": "Bad Gateway" }, { "_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", @@ -39437,46 +39548,54 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, - "status": "Gateway Timeout" + "status": "Unsupported Media Type" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"created\": \"\",\n \"createdBy\": \"\",\n \"scheduledFrom\": \"\",\n \"status\": \"\",\n \"downloadURL\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 429, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -39484,34 +39603,52 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, - "status": "OK" + "status": "Too Many Requests" }, { "_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": { "header": [], "method": "GET", @@ -39521,26 +39658,44 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, - "status": "Unsupported Media Type" + "status": "Gone" }, { "_postman_previewlanguage": "text", @@ -39558,36 +39713,64 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 428, + "_postman_previewlanguage": "json", + "body": "{\n \"Report Attributes\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"created\": \"\",\n \"createdBy\": \"\",\n \"scheduledFrom\": \"\",\n \"status\": \"\",\n \"downloadURL\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"created\": \"\",\n \"createdBy\": \"\",\n \"scheduledFrom\": \"\",\n \"status\": \"\",\n \"downloadURL\": \"\"\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": [ @@ -39595,43 +39778,79 @@ ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", + "value": "" + }, + { + "description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.", + "key": "regionId", + "value": "" + }, { "description": "The encoded organization ID for the sub partner.", "key": "onBehalfOfSubPartnerOrgId", "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?service=&templateId=&from=&to=®ionId=&onBehalfOfSubPartnerOrgId=" } }, - "status": "Precondition Required" + "status": "OK" } ] }, { - "name": "Delete a Report", + "name": "Create a Report", "request": { - "description": "Remove a report from the system.\n\nSpecify the report ID in the `reportId` parameter in the URI\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_write` scope.", - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "description": "Create a new report. A new report can be created using `templateId` available from the _List Report Templates_ API. For each `templateId`, there are a set of validation rules that need to be followed.\n\nThe `templateId` parameter is a number. However, it is a limitation of developer.webex.com platform that it is passed as a string when you try to test the API from here.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_write` and `identity:people_read` scopes.\n\n**Notes**:\n\n
CSV reports for Webex suite services are only created for organizations in the specified region. Organizations based in a different region will require a separate request with region specified.
\n\n
When no region is specified, the request defaults to Partner organization's home region. A request against a region where there are no organizations will return blank CSV files.
", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ { @@ -39640,35 +39859,42 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId", - "value": "" - } - ] + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, "response": [ { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ { @@ -39677,35 +39903,43 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, - "status": "Forbidden" + "status": "Unsupported Media Type" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ { @@ -39714,35 +39948,43 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, - "status": "Unauthorized" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 428, "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": "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 \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ { @@ -39751,35 +39993,43 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, - "status": "Internal Server Error" + "status": "Precondition Required" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ { @@ -39788,35 +40038,43 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Gateway" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ { @@ -39825,35 +40083,43 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, - "status": "No Content" + "status": "Conflict" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ { @@ -39862,35 +40128,43 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, - "status": "Unsupported Media Type" + "status": "Method Not Allowed" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ { @@ -39899,35 +40173,43 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, - "status": "Precondition Required" + "status": "Not Found" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ { @@ -39936,35 +40218,52 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, - "status": "Gone" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 400, + "_postman_previewlanguage": "json", + "body": "{\n \"reportId\": \"\",\n \"createdTime\": \"\"\n}", + "code": 200, "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": "OK", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ { @@ -39973,35 +40272,43 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, - "status": "Bad Request" + "status": "OK" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ { @@ -40010,35 +40317,43 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, - "status": "Not Found" + "status": "Bad Request" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ { @@ -40047,35 +40362,43 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ { @@ -40084,35 +40407,43 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, - "status": "Method Not Allowed" + "status": "Forbidden" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ { @@ -40121,35 +40452,43 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, - "status": "Gateway Timeout" + "status": "Unauthorized" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ { @@ -40158,72 +40497,88 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, - "status": "Conflict" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "partner", - "reports", - ":reportId" - ], - "query": [ - { - "description": "The encoded organization ID for the sub partner.", - "key": "onBehalfOfSubPartnerOrgId", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ + "path": [ + "partner", + "reports" + ], + "query": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, - "status": "Bad Gateway" + "status": "Too Many Requests" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"regionId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "partner", - "reports", - ":reportId" + "reports" ], "query": [ { @@ -40232,23 +40587,17 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId" - } - ] + "raw": "{{baseUrl}}/partner/reports?onBehalfOfSubPartnerOrgId=" } }, - "status": "Too Many Requests" + "status": "Gateway Timeout" } ] }, { - "name": "List Report Templates", + "name": "Get Report Details", "request": { - "description": "List report templates. Report templates are available for use with the Partner Reports API.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_read` and `identity:people_read` [scopes](/docs/integrations#scopes). The authenticated user must be a Partner full administrator or Partner read-only administrator of the organization.", + "description": "Shows details for a report by report ID.\n\nSpecify the report ID in the `reportId` parameter in the URI.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_read` and `identity:people_read` scopes.\n\n**Notes**:\n\n
Reports are usually provided in zip format. A content-header application/zip or application/octet-stream does indicate the zip format. There is usually no .zip file extension.
", "header": [ { "key": "Accept", @@ -40263,7 +40612,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40272,17 +40621,24 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId", + "value": "" + } + ] } }, "response": [ { "_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": { "header": [], "method": "GET", @@ -40293,7 +40649,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40302,18 +40658,24 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Unsupported Media Type" + "status": "Conflict" }, { "_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", @@ -40324,7 +40686,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40333,18 +40695,24 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Gateway Timeout" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 401, "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": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], "method": "GET", @@ -40355,7 +40723,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40364,18 +40732,24 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Conflict" + "status": "Unauthorized" }, { "_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", @@ -40386,7 +40760,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40395,18 +40769,24 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Not Found" + "status": "Bad Request" }, { "_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", @@ -40417,7 +40797,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40426,18 +40806,24 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Internal Server Error" + "status": "Bad Gateway" }, { "_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": { "header": [], "method": "GET", @@ -40448,7 +40834,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40457,18 +40843,24 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Unauthorized" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { "header": [], "method": "GET", @@ -40479,7 +40871,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40488,18 +40880,24 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Gone" + "status": "Method Not Allowed" }, { "_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", @@ -40510,7 +40908,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40519,18 +40917,24 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "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": { "header": [], "method": "GET", @@ -40541,7 +40945,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40550,18 +40954,24 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Forbidden" + "status": "Service Unavailable" }, { "_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", @@ -40572,7 +40982,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40581,18 +40991,24 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Bad Request" + "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": "GET", @@ -40603,7 +41019,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40612,18 +41028,24 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Method Not Allowed" + "status": "Too Many Requests" }, { "_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", @@ -40634,7 +41056,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40643,20 +41065,36 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Precondition Required" + "status": "Gateway Timeout" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 502, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\",\n \"created\": \"\",\n \"createdBy\": \"\",\n \"scheduledFrom\": \"\",\n \"status\": \"\",\n \"downloadURL\": \"\"\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": [ @@ -40665,7 +41103,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40674,18 +41112,24 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Bad Gateway" + "status": "OK" }, { "_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", @@ -40696,7 +41140,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40705,18 +41149,24 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Too Many Requests" + "status": "Unsupported Media Type" }, { "_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": { "header": [], "method": "GET", @@ -40727,7 +41177,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40736,30 +41186,26 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"Template Collection\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"maxDays\": \"\",\n \"identifier\": \"\",\n \"validations\": {\n \"validations\": [\n {\n \"field\": \"\",\n \"required\": \"\"\n },\n {\n \"field\": \"\",\n \"required\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"maxDays\": \"\",\n \"identifier\": \"\",\n \"validations\": {\n \"validations\": [\n {\n \"field\": \"\",\n \"required\": \"\"\n },\n {\n \"field\": \"\",\n \"required\": \"\"\n }\n ]\n }\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 428, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -40768,7 +41214,7 @@ "path": [ "partner", "reports", - "templates" + ":reportId" ], "query": [ { @@ -40777,657 +41223,384 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "OK" + "status": "Precondition Required" } ] - } - ], - "name": "Partner Reports/Templates" - }, - { - "item": [ + }, { - "name": "List People", + "name": "Delete a Report", "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. 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", - "value": "application/json" - } - ], - "method": "GET", + "description": "Remove a report from the system.\n\nSpecify the report ID in the `reportId` parameter in the URI\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_write` scope.", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + ":reportId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, + } + ], + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ { - "description": "List people present in this location.", - "key": "locationId", + "description": "The unique identifier for the report.", + "key": "reportId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } - ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + ] } }, "response": [ { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + ":reportId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, + } + ], + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_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": [ + "partner", + "reports", + ":reportId" + ], + "query": [ { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Gateway Timeout" + "status": "Unauthorized" }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + ":reportId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Unsupported Media Type" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"mobile\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"presenting\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"person\"\n },\n {\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"work_extension\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"inactive\",\n \"invitePending\": \"false\",\n \"loginEnabled\": \"true\",\n \"type\": \"appuser\"\n }\n ],\n \"notFoundIds\": [\n \"\",\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" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + ":reportId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "OK" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + ":reportId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Gone" + "status": "No Content" }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + ":reportId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "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. An accompanying error message will explain further.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + ":reportId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Bad Request" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 410, "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": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + ":reportId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Internal Server Error" + "status": "Gone" }, { "_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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + ":reportId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", @@ -41438,62 +41611,30 @@ "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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + ":reportId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, "status": "Not Found" @@ -41507,62 +41648,30 @@ "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + ":reportId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, "status": "Service Unavailable" @@ -41570,140 +41679,113 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 405, "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": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + ":reportId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Too Many Requests" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 504, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method 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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + ":reportId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, + } + ], + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_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": [ + "partner", + "reports", + ":reportId" + ], + "query": [ { - "description": "List people present in this location.", - "key": "locationId", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Method Not Allowed" + "status": "Conflict" }, { "_postman_previewlanguage": "text", @@ -41714,62 +41796,30 @@ "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + ":reportId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, "status": "Bad Gateway" @@ -41777,79 +41827,111 @@ { "_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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + ":reportId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, + } + ], + "raw": "{{baseUrl}}/partner/reports/:reportId?onBehalfOfSubPartnerOrgId=", + "variable": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "List Report Templates", + "request": { + "description": "List report templates. Report templates are available for use with the Partner Reports API.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_read` and `identity:people_read` [scopes](/docs/integrations#scopes). The authenticated user must be a Partner full administrator or Partner read-only administrator of the organization.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "partner", + "reports", + "templates" + ], + "query": [ + { + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" + } + }, + "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": [ + "partner", + "reports", + "templates" + ], + "query": [ { - "description": "List people present in this location.", - "key": "locationId", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" } }, - "status": "Forbidden" + "status": "Unsupported Media Type" }, { "_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", @@ -41858,59 +41940,21 @@ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + "templates" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" } }, - "status": "Precondition Required" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -41927,657 +41971,331 @@ "{{baseUrl}}" ], "path": [ - "people" - ], + "partner", + "reports", + "templates" + ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" } }, "status": "Conflict" - } - ] - }, - { - "name": "Create a Person", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, - "description": "Create a new user account for a given organization. Only an admin can create a new user account.\n\nAt least one of the following body parameters is required to create a new user: `displayName`, `firstName`, `lastName`.\n\nCurrently, users may have only one email address associated with their account. The `emails` parameter is an array, which accepts multiple values to allow for future expansion, but currently only one email address will be used for the new user.\n\nAdmin users can include `Webex calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true. It may happen that the POST request with calling data returns a 400 status, but the person was created still. One way to get into this state is if an invalid phone number is assigned to a user. The people API aggregates calls to several other microservices, and one may have failed. A best practice is to check if the user exists before retrying. This can be done with the user's email address and a GET /people.\n\nWhen doing attendee management, append `#attendee` to the `siteUrl` parameter (e.g. `mysite.webex.com#attendee`) to make the new user an attendee for a site.\n\n**NOTES**:\n\n* For creating a `Webex Calling` user, you must provide `phoneNumbers` or `extension`, `locationId`, and `licenses` string in the same request.\n\n* `SipAddresses` are asigned via an asynchronous process. This means that the POST response may not show the SIPAddresses immediately. Instead you can verify them with a separate GET to /people, after they were newly configured.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "people" - ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" - } - ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" - } - }, - "response": [ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + "templates" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" } }, - "status": "Gone" + "status": "Not Found" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + "templates" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + "templates" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" } }, - "status": "Precondition Required" + "status": "Unauthorized" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + "templates" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" } }, - "status": "Not Found" + "status": "Gone" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"work_extension\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"DoNotDisturb\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"bot\"\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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + "templates" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" } }, - "status": "OK" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + "templates" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" } }, - "status": "Gateway Timeout" + "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + "templates" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 405, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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 \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + "templates" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" } }, - "status": "Unauthorized" + "status": "Method Not Allowed" }, { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + "templates" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "people" - ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" - } - ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" - } - }, - "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 \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + "templates" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" } }, - "status": "Conflict" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", @@ -42587,96 +42305,29 @@ "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 \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + "templates" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" } }, "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "people" - ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" - } - ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" - } - }, - "status": "Unsupported Media Type" - }, { "_postman_previewlanguage": "text", "body": null, @@ -42685,151 +42336,81 @@ "header": [], "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + "templates" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" } }, "status": "Service Unavailable" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 405, + "_postman_previewlanguage": "json", + "body": "{\n \"Template Collection\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"maxDays\": \"\",\n \"identifier\": \"\",\n \"validations\": {\n \"validations\": [\n {\n \"field\": \"\",\n \"required\": \"\"\n },\n {\n \"field\": \"\",\n \"required\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"maxDays\": \"\",\n \"identifier\": \"\",\n \"validations\": {\n \"validations\": [\n {\n \"field\": \"\",\n \"required\": \"\"\n },\n {\n \"field\": \"\",\n \"required\": \"\"\n }\n ]\n }\n }\n ]\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.", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "people" - ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" - } - ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "header": [ + { + "key": "Content-Type", + "value": "application/json" } - }, - "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.", + ], + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "partner", + "reports", + "templates" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "The encoded organization ID for the sub partner.", + "key": "onBehalfOfSubPartnerOrgId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/partner/reports/templates?onBehalfOfSubPartnerOrgId=" } }, - "status": "Bad Gateway" + "status": "OK" } ] - }, + } + ], + "name": "Partner Reports/Templates" + }, + { + "item": [ { - "name": "Get Person Details", + "name": "List People", "request": { - "description": "Shows details for a person, by ID.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be displayed for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/).\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`.\n\nSpecify the person ID in the `personId` parameter in the URI.", + "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", @@ -42842,34 +42423,66 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId", + "description": "List people present in this location.", + "key": "locationId", "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, "response": [ { "_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", @@ -42878,34 +42491,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_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", @@ -42914,106 +42560,155 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Unauthorized" + "status": "Unsupported Media Type" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 410, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"mobile\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"presenting\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"person\"\n },\n {\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"work_extension\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"inactive\",\n \"invitePending\": \"false\",\n \"loginEnabled\": \"true\",\n \"type\": \"appuser\"\n }\n ],\n \"notFoundIds\": [\n \"\",\n \"\"\n ]\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Gone: The requested resource is no longer available.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] - } - }, - "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": [ - "people", - ":personId" - ], - "query": [ + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Precondition Required" + "status": "OK" }, { "_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": "GET", @@ -43022,34 +42717,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Not Found" + "status": "Gone" }, { "_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": { "header": [], "method": "GET", @@ -43058,34 +42786,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Gateway Timeout" + "status": "Unauthorized" }, { "_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": { "header": [], "method": "GET", @@ -43094,34 +42855,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Unsupported Media Type" + "status": "Bad Request" }, { "_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": { "header": [], "method": "GET", @@ -43130,34 +42924,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 423, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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", @@ -43166,80 +42993,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"work_extension\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"DoNotDisturb\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"bot\"\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": [ - "people", - ":personId" - ], - "query": [ + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "OK" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { "header": [], "method": "GET", @@ -43248,34 +43062,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Bad Request" + "status": "Not Found" }, { "_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": { "header": [], "method": "GET", @@ -43284,34 +43131,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Bad Gateway" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 429, "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": "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", @@ -43320,34 +43200,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 405, "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": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -43356,34 +43269,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Too Many Requests" + "status": "Method Not Allowed" }, { "_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", @@ -43392,34 +43338,136 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + } + }, + "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": [ + "people" + ], + "query": [ { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + }, + { + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_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", @@ -43428,31 +43476,133 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + } + }, + "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": [ + "people" + ], + "query": [ { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + }, + { + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Method Not Allowed" + "status": "Conflict" } ] }, { - "name": "Update a Person", + "name": "Create a Person", "request": { "body": { "mode": "raw", @@ -43462,9 +43612,9 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, - "description": "Update details for a person, by ID.\n\nSpecify the person ID in the `personId` parameter in the URI. Only an admin can update a person details.\n\nInclude all details for the person. This action expects all user details to be present in the request. A common approach is to first [GET the person's details](/docs/api/v1/people/get-person-details), make changes, then PUT both the changed and unchanged values.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.\n\nWhen doing attendee management, to update a user from host role to an attendee for a site append `#attendee` to the respective `siteUrl` and remove the meeting host license for this site from the license array.\nTo update a person from an attendee role to a host for a site, add the meeting license for this site in the meeting array, and remove that site from the `siteurl` parameter.\n\nTo remove the attendee privilege for a user on a meeting site, remove the `sitename#attendee` from the `siteUrl`s array. The `showAllTypes` parameter must be set to `true`.\n\n**NOTE**:\n\n* The `locationId` can only be set when assigning a calling license to a user. It cannot be changed if a user is already an existing calling user.\n\n* The `extension` field should be used to update the Webex Calling extension for a person. The extension value should not include the location routing prefix. The `work_extension` type in the `phoneNumbers` object as seen in the response payload of [List People](/docs/api/v1/people/list-people) or [Get Person Details](/docs/api/v1/people/get-person-details), cannot be used to set the Webex Calling extension for a person.\n\n* When updating a user with multiple email addresses using a PUT request, ensure that the primary email address is listed first in the array. Note that the order of email addresses returned by a GET request is not guaranteed..\n\n* The People API is a combination of several microservices, each responsible for specific attributes of a person. As a result, a PUT request that returns an error response code may still have altered some values of the person's data. Therefore, it is recommended to perform a GET request after encountering an error to verify the current state of the resource. \n\n* Some licenses are implicitly assigned by the system and cannot be admin controlled. They are necessary for the baseline function of the Webex system. If you get an error about implicitly assigned licensed that cannot be removed, please ensure you have the corresponding license in your PUT request.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.", + "description": "Create a new user account for a given organization. Only an admin can create a new user account.\n\nAt least one of the following body parameters is required to create a new user: `displayName`, `firstName`, `lastName`.\n\nCurrently, users may have only one email address associated with their account. The `emails` parameter is an array, which accepts multiple values to allow for future expansion, but currently only one email address will be used for the new user.\n\nAdmin users can include `Webex calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true. It may happen that the POST request with calling data returns a 400 status, but the person was created still. One way to get into this state is if an invalid phone number is assigned to a user. The people API aggregates calls to several other microservices, and one may have failed. A best practice is to check if the user exists before retrying. This can be done with the user's email address and a GET /people.\n\nWhen doing attendee management, append `#attendee` to the `siteUrl` parameter (e.g. `mysite.webex.com#attendee`) to make the new user an attendee for a site.\n\n**NOTES**:\n\n* For creating a `Webex Calling` user, you must provide `phoneNumbers` or `extension`, `locationId`, and `licenses` string in the same request.\n\n* `SipAddresses` are asigned via an asynchronous process. This means that the POST response may not show the SIPAddresses immediately. Instead you can verify them with a separate GET to /people, after they were newly configured.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.", "header": [ { "key": "Content-Type", @@ -43475,14 +43625,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -43491,39 +43640,22 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId", - "value": "" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"work_extension\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"DoNotDisturb\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"bot\"\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 410, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "body": { "mode": "raw", @@ -43533,26 +43665,21 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -43561,34 +43688,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "OK" + "status": "Gone" }, { "_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", @@ -43598,7 +43714,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -43606,14 +43722,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -43622,34 +43737,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Not Found" + "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": { "body": { "mode": "raw", @@ -43659,7 +43763,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -43667,14 +43771,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -43683,34 +43786,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Unauthorized" + "status": "Precondition Required" }, { "_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": "raw", @@ -43720,7 +43812,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -43728,14 +43820,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -43744,34 +43835,28 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Unsupported Media Type" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 429, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"work_extension\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"DoNotDisturb\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"bot\"\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": { "body": { "mode": "raw", @@ -43781,83 +43866,25 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "people", - ":personId" - ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] - } - }, - "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" - }, - "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -43866,34 +43893,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Precondition Required" + "status": "OK" }, { "_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": { "body": { "mode": "raw", @@ -43903,7 +43919,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -43911,14 +43927,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -43927,34 +43942,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Gone" + "status": "Gateway Timeout" }, { "_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": "raw", @@ -43964,7 +43968,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -43972,14 +43976,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -43988,34 +43991,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Bad Gateway" + "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": { "body": { "mode": "raw", @@ -44025,7 +44017,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -44033,14 +44025,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -44049,26 +44040,15 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Service Unavailable" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -44086,7 +44066,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -44094,14 +44074,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -44110,23 +44089,12 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, "status": "Locked (WebDAV) (RFC 4918)" @@ -44134,10 +44102,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 403, "cookie": [], "header": [], - "name": "No Content", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "body": { "mode": "raw", @@ -44147,7 +44115,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -44155,14 +44123,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -44171,34 +44138,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "No Content" + "status": "Forbidden" }, { "_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": { "body": { "mode": "raw", @@ -44208,7 +44164,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -44216,14 +44172,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -44232,34 +44187,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 429, "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": "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", @@ -44269,7 +44213,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -44277,14 +44221,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -44293,34 +44236,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 415, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -44330,7 +44262,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -44338,14 +44270,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -44354,34 +44285,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Bad Request" + "status": "Unsupported Media Type" }, { "_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", @@ -44391,7 +44311,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -44399,14 +44319,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -44415,26 +44334,15 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Gateway Timeout" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", @@ -44452,7 +44360,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -44460,14 +44368,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -44476,23 +44383,12 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, "status": "Method Not Allowed" @@ -44500,10 +44396,10 @@ { "_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", @@ -44513,7 +44409,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -44521,14 +44417,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -44537,35 +44432,29 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Forbidden" + "status": "Bad Gateway" } ] }, { - "name": "Delete a Person", + "name": "Get Person Details", "request": { - "description": "Remove a person from the system.\n\n**Required Administrator Roles:**\n\nThe following administrators have permission to use this API:\n\n**Customer Organization:**\n- Full administrator\n- User administrator\n\n**Partner/External Access:**\n- External full administrator\n\n**Note:** External read-only administrators, provisioning administrators, and device administrators cannot delete users.\n\nSpecify the person ID in the `personId` parameter in the URI.", - "header": [], - "method": "DELETE", + "description": "Shows details for a person, by ID.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be displayed for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/).\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`.\n\nSpecify the person ID in the `personId` parameter in the URI.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -44574,7 +44463,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -44588,13 +44484,13 @@ { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -44603,7 +44499,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -44612,18 +44515,18 @@ ] } }, - "status": "Precondition Required" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -44632,7 +44535,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -44641,18 +44551,18 @@ ] } }, - "status": "Service Unavailable" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 410, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -44661,7 +44571,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -44670,18 +44587,18 @@ ] } }, - "status": "Bad Request" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 428, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. 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}}" @@ -44690,7 +44607,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -44699,18 +44623,18 @@ ] } }, - "status": "Bad Gateway" + "status": "Precondition Required" }, { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -44719,7 +44643,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -44728,18 +44659,18 @@ ] } }, - "status": "Forbidden" + "status": "Not Found" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -44748,7 +44679,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -44757,18 +44695,18 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_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}}" @@ -44777,7 +44715,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -44786,18 +44731,18 @@ ] } }, - "status": "Too Many Requests" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 503, "cookie": [], "header": [], - "name": "No Content", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -44806,7 +44751,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -44815,18 +44767,18 @@ ] } }, - "status": "No Content" + "status": "Service Unavailable" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -44835,7 +44787,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -44844,18 +44803,28 @@ ] } }, - "status": "Not Found" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 415, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"work_extension\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"DoNotDisturb\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"bot\"\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", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -44864,7 +44833,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -44873,18 +44849,18 @@ ] } }, - "status": "Unsupported Media Type" + "status": "OK" }, { "_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}}" @@ -44893,7 +44869,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -44902,18 +44885,18 @@ ] } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -44922,7 +44905,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -44931,7 +44921,7 @@ ] } }, - "status": "Internal Server Error" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", @@ -44942,7 +44932,7 @@ "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}}" @@ -44951,7 +44941,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -44965,13 +44962,13 @@ { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -44980,7 +44977,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -44989,18 +44993,18 @@ ] } }, - "status": "Gone" + "status": "Too Many Requests" }, { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -45009,7 +45013,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -45018,7 +45029,7 @@ ] } }, - "status": "Gateway Timeout" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -45029,7 +45040,7 @@ "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}}" @@ -45038,7 +45049,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -45052,124 +45070,196 @@ ] }, { - "name": "Get My Own Details", + "name": "Update a Person", "request": { - "description": "Get profile details for the authenticated user. This is the same as GET `/people/{personId}` using the Person ID associated with your Auth token.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "description": "Update details for a person, by ID.\n\nSpecify the person ID in the `personId` parameter in the URI. Only an admin can update a person details.\n\nInclude all details for the person. This action expects all user details to be present in the request. A common approach is to first [GET the person's details](/docs/api/v1/people/get-person-details), make changes, then PUT both the changed and unchanged values.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.\n\nWhen doing attendee management, to update a user from host role to an attendee for a site append `#attendee` to the respective `siteUrl` and remove the meeting host license for this site from the license array.\nTo update a person from an attendee role to a host for a site, add the meeting license for this site in the meeting array, and remove that site from the `siteurl` parameter.\n\nTo remove the attendee privilege for a user on a meeting site, remove the `sitename#attendee` from the `siteUrl`s array. The `showAllTypes` parameter must be set to `true`.\n\n**NOTE**:\n\n* When assigning a Webex Calling license, either a telephone number or extension must already be assigned to the person or provided in the request payload.\n\n* When `callingData` is set to `true`, a Webex Calling license must be included in the `licenses` array.\n\n* The `locationId` can only be set when assigning a calling license to a user. It cannot be changed if a user is already an existing calling user.\n\n* The `extension` field should be used to update the Webex Calling extension for a person. The extension value should not include the location routing prefix. The `work_extension` type in the `phoneNumbers` object as seen in the response payload of [List People](/docs/api/v1/people/list-people) or [Get Person Details](/docs/api/v1/people/get-person-details), cannot be used to set the Webex Calling extension for a person.\n\n* When updating a user with multiple email addresses using a PUT request, ensure that the primary email address is listed first in the array. Note that the order of email addresses returned by a GET request is not guaranteed..\n\n* The People API is a combination of several microservices, each responsible for specific attributes of a person. As a result, a PUT request that returns an error response code may still have altered some values of the person's data. Therefore, it is recommended to perform a GET request after encountering an error to verify the current state of the resource. \n\n* Some licenses are implicitly assigned by the system and cannot be admin controlled. They are necessary for the baseline function of the Webex system. If you get an error about implicitly assigned licensed that cannot be removed, please ensure you have the corresponding license in your PUT request.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId", + "value": "" + } + ] } }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 410, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"work_extension\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"DoNotDisturb\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"bot\"\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Gone: The requested resource is no longer available.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/me?callingData=false" - } - }, - "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": [ - "people", - "me" - ], - "query": [ + }, { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Method Not Allowed" + "status": "OK" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Forbidden" + "status": "Not Found" }, { "_postman_previewlanguage": "text", @@ -45179,24 +45269,55 @@ "header": [], "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, "status": "Unauthorized" @@ -45204,32 +45325,63 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 415, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. 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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Bad Gateway" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", @@ -45239,24 +45391,55 @@ "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, "status": "Too Many Requests" @@ -45264,92 +45447,185 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 428, "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": "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 \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Internal Server Error" + "status": "Precondition Required" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gone" }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Not Found" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", @@ -45359,1081 +45635,979 @@ "header": [], "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 \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, "status": "Service Unavailable" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"work_extension\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"DoNotDisturb\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"bot\"\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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "OK" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 204, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "No Content", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Bad Request" + "status": "No Content" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Gateway Timeout" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 409, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "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 \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Precondition Required" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 400, "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 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 \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Conflict" + "status": "Bad Request" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Unsupported Media Type" - } - ] - } - ], - "name": "People" - }, - { - "item": [ - { - "name": "List of Recording Audit Report Summaries", - "request": { - "description": "Lists of recording audit report summaries. You can specify a date range and the maximum number of recording audit report summaries to return.\n\nOnly recording audit report summaries of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the recording audit report summaries of the specified site will be listed; otherwise, recording audit report summaries of the user's preferred site will be listed. All available Webex sites and the preferred site of the user can be retrieved by the `Get Site List` API.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "recordingReport", - "accessSummary" - ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" - } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" - } - }, - "response": [ + "status": "Gateway Timeout" + }, { "_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", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, "header": [ { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], "query": [ { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" }, { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" }, { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Gone" + "status": "Method Not Allowed" }, { "_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", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, "header": [ { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], "query": [ { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" }, { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" }, { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Internal Server Error" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"recordingId\": \"\",\n \"topic\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"hostEmail\": \"\",\n \"viewCount\": \"\",\n \"downloadCount\": \"\"\n },\n {\n \"recordingId\": \"\",\n \"topic\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"hostEmail\": \"\",\n \"viewCount\": \"\",\n \"downloadCount\": \"\"\n }\n ]\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json;charset=UTF-8" - }, + "status": "Forbidden" + } + ] + }, + { + "name": "Delete a Person", + "request": { + "description": "Remove a person from the system.\n\n**Required Administrator Roles:**\n\nThe following administrators have permission to use this API:\n\n**Customer Organization:**\n- Full administrator\n- User administrator\n\n**Partner/External Access:**\n- External full administrator\n\n**Note:** External read-only administrators, provisioning administrators, and device administrators cannot delete users.\n\nSpecify the person ID in the `personId` parameter in the URI.", + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "people", + ":personId" + ], + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", + "description": "A unique identifier for the person.", + "key": "personId", "value": "" } - ], - "name": "OK", + ] + } + }, + "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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "OK" + "status": "Precondition Required" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Not Found" + "status": "Service Unavailable" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Request" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Bad Request" + "status": "Bad Gateway" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Unsupported Media Type" + "status": "Forbidden" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Bad Gateway" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 429, "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": "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 204, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "No Content", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Unauthorized" + "status": "No Content" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Precondition Required" + "status": "Unsupported Media Type" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Forbidden" + "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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "description": "A unique identifier for the person.", + "key": "personId" + } + ] + } + }, + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "people", + ":personId" + ], + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } + ] + } + }, + "status": "Conflict" + }, + { + "_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}}" ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + "path": [ + "people", + ":personId" + ], + "raw": "{{baseUrl}}/people/:personId", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Service Unavailable" + "status": "Gone" }, { "_postman_previewlanguage": "text", @@ -46443,50 +46617,23 @@ "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, "status": "Gateway Timeout" @@ -46499,50 +46646,23 @@ "header": [], "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, "status": "Method Not Allowed" @@ -46550,18 +46670,13 @@ ] }, { - "name": "Get Recording Audit Report Details", + "name": "Get My Own Details", "request": { - "description": "Retrieves details for a recording audit report with a specified recording ID.\n\nOnly recording audit report details of meetings hosted by or shared with the authenticated user may be retrieved.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", + "description": "Get profile details for the authenticated user. This is the same as GET `/people/{personId}` using the Person ID associated with your Auth token.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.", "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, { "key": "Accept", - "value": "application/json;charset=UTF-8" + "value": "application/json" } ], "method": "GET", @@ -46570,521 +46685,337 @@ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"recordingId\": \"\",\n \"topic\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"accessTime\": \"\",\n \"viewed\": \"\",\n \"downloaded\": \"\"\n },\n {\n \"recordingId\": \"\",\n \"topic\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"accessTime\": \"\",\n \"viewed\": \"\",\n \"downloaded\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 410, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json;charset=UTF-8" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" - } - ], - "name": "OK", + "header": [], + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "OK" + "status": "Gone" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Gone" + "status": "Method Not Allowed" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Method Not Allowed" + "status": "Forbidden" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Unsupported Media Type" + "status": "Unauthorized" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Conflict" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 429, "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": "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Gateway Timeout" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 500, "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": "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 423, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Bad Request" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 404, "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": "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 503, "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": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Internal Server Error" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 429, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"work_extension\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"DoNotDisturb\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"bot\"\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": [ { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "key": "Accept", + "value": "application/json" } ], "method": "GET", @@ -47093,267 +47024,182 @@ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Too Many Requests" + "status": "OK" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Bad Gateway" + "status": "Bad Request" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Service Unavailable" + "status": "Gateway Timeout" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Unauthorized" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 409, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Precondition Required" + "status": "Conflict" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Forbidden" + "status": "Unsupported Media Type" } ] - }, - { - "name": "List Meeting Archive Summaries", + } + ], + "name": "People" + }, + { + "item": [ + { + "name": "List of Recording Audit Report Summaries", "request": { - "description": "Lists of meeting archive summaries. You can specify a date range and the maximum number of meeting archive summaries to return.\n\nMeeting archive summaries are only available to full administrators, not even the meeting host.\n\nThe list returned is sorted in descending order by the date and time that the archives were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the meeting archive summaries of the specified site will be listed; otherwise, meeting archive summaries of the user's preferred site will be listed. All available Webex sites and the preferred site of the user can be retrieved by the `Get Site List` API.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", + "description": "Lists of recording audit report summaries. You can specify a date range and the maximum number of recording audit report summaries to return.\n\nOnly recording audit report summaries of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the recording audit report summaries of the specified site will be listed; otherwise, recording audit report summaries of the user's preferred site will be listed. All available Webex sites and the preferred site of the user can be retrieved by the `Get Site List` API.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", "header": [ { "description": "e.g. UTC", @@ -47372,41 +47218,46 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, "response": [ { "_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": { "header": [ { @@ -47422,42 +47273,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Too Many Requests" + "status": "Gone" }, { "_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": [ { @@ -47473,48 +47329,71 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Conflict" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 504, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"recordingId\": \"\",\n \"topic\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"hostEmail\": \"\",\n \"viewCount\": \"\",\n \"downloadCount\": \"\"\n },\n {\n \"recordingId\": \"\",\n \"topic\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"hostEmail\": \"\",\n \"viewCount\": \"\",\n \"downloadCount\": \"\"\n }\n ]\n}", + "code": 200, "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;charset=UTF-8" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { "header": [ { "description": "e.g. UTC", "key": "timezone", "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], "method": "GET", @@ -47524,42 +47403,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Gateway Timeout" + "status": "OK" }, { "_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": { "header": [ { @@ -47575,42 +47459,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Gone" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 423, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "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": [ { @@ -47626,42 +47515,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Method Not Allowed" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": [ { @@ -47677,42 +47571,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_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": { "header": [ { @@ -47728,42 +47627,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Forbidden" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 502, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [ { @@ -47779,42 +47683,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Service Unavailable" + "status": "Bad Gateway" }, { "_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": [ { @@ -47830,42 +47739,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Unauthorized" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 401, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [ { @@ -47881,66 +47795,53 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Bad Gateway" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"archiveId\": \"\",\n \"serviceType\": \"SupportCenter\",\n \"title\": \"\",\n \"createTime\": \"\"\n },\n {\n \"archiveId\": \"\",\n \"serviceType\": \"MeetingCenter\",\n \"title\": \"\",\n \"createTime\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 429, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json;charset=UTF-8" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" - } - ], - "name": "OK", + "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": [ { "description": "e.g. UTC", "key": "timezone", "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" } ], "method": "GET", @@ -47950,42 +47851,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "OK" + "status": "Too Many Requests" }, { "_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": [ { @@ -48001,42 +47907,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Unsupported Media Type" + "status": "Precondition Required" }, { "_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": [ { @@ -48052,42 +47963,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_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": [ { @@ -48103,42 +48019,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Precondition Required" + "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": [ { @@ -48154,42 +48075,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_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": [ { @@ -48205,41 +48131,46 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Not Found" + "status": "Method Not Allowed" } ] }, { - "name": "Get Meeting Archive Details", + "name": "Get Recording Audit Report Details", "request": { - "description": "Retrieves details for a meeting archive report with a specified archive ID, which contains recording metadata.\n\nMeeting archive details are only available to full administrators, not even the meeting host.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", + "description": "Retrieves details for a recording audit report with a specified recording ID.\n\nOnly recording audit report details of meetings hosted by or shared with the authenticated user may be retrieved.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", "header": [ { "description": "e.g. UTC", @@ -48258,33 +48189,60 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId", + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 410, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"recordingId\": \"\",\n \"topic\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"accessTime\": \"\",\n \"viewed\": \"\",\n \"downloaded\": \"\"\n },\n {\n \"recordingId\": \"\",\n \"topic\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"accessTime\": \"\",\n \"viewed\": \"\",\n \"downloaded\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Gone: The requested resource is no longer available.", + "header": [ + { + "key": "Content-Type", + "value": "application/json;charset=UTF-8" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { "header": [ { "description": "e.g. UTC", "key": "timezone", "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], "method": "GET", @@ -48294,27 +48252,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" - } - ] - } - }, - "status": "Gone" - }, + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + } + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + } + }, + "status": "OK" + }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 410, "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": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [ { @@ -48330,27 +48298,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Internal Server Error" + "status": "Gone" }, { "_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": [ { @@ -48366,27 +48344,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Not Found" + "status": "Method Not Allowed" }, { "_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": { "header": [ { @@ -48402,27 +48390,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Method Not Allowed" + "status": "Unsupported Media Type" }, { "_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": [ { @@ -48438,27 +48436,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Too Many Requests" + "status": "Conflict" }, { "_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": [ { @@ -48474,27 +48482,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Bad Gateway" + "status": "Gateway Timeout" }, { "_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": { "header": [ { @@ -48510,19 +48528,29 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Precondition Required" + "status": "Not Found" }, { "_postman_previewlanguage": "text", @@ -48546,16 +48574,26 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, "status": "Bad Request" @@ -48563,10 +48601,10 @@ { "_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": [ { @@ -48582,27 +48620,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Service Unavailable" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": [ { @@ -48618,27 +48666,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Unsupported Media Type" + "status": "Internal Server Error" }, { "_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": { "header": [ { @@ -48654,27 +48712,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_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": { "header": [ { @@ -48690,27 +48758,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Conflict" + "status": "Bad Gateway" }, { "_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": [ { @@ -48726,27 +48804,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Gateway Timeout" + "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": [ { @@ -48762,27 +48850,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unauthorized" }, { "_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": [ { @@ -48798,42 +48896,43 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Unauthorized" + "status": "Precondition Required" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"archiveId\": \"\",\n \"serviceType\": \"MeetingCenter\",\n \"title\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"participants\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"joinedTime\": \"\",\n \"leftTime\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"joinedTime\": \"\",\n \"leftTime\": \"\",\n \"email\": \"\"\n }\n ],\n \"chats\": [\n {\n \"type\": \"\",\n \"senderName\": \"\",\n \"chatTime\": \"\",\n \"target\": \"\",\n \"text\": \"\"\n },\n {\n \"type\": \"\",\n \"senderName\": \"\",\n \"chatTime\": \"\",\n \"target\": \"\",\n \"text\": \"\"\n }\n ],\n \"polls\": [\n {\n \"type\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"content\": {\n \"questionCount\": \"\",\n \"userCount\": \"\",\n \"votedUserCount\": \"\",\n \"questions\": [\n {\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"question\": {\n \"choiceCount\": \"\",\n \"type\": \"\",\n \"text\": \"\"\n },\n \"answerSummary\": [\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n },\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n }\n ],\n \"respondents\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"question\": {\n \"choiceCount\": \"\",\n \"type\": \"\",\n \"text\": \"\"\n },\n \"answerSummary\": [\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n },\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n }\n ],\n \"respondents\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n }\n },\n {\n \"type\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"content\": {\n \"questionCount\": \"\",\n \"userCount\": \"\",\n \"votedUserCount\": \"\",\n \"questions\": [\n {\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"question\": {\n \"choiceCount\": \"\",\n \"type\": \"\",\n \"text\": \"\"\n },\n \"answerSummary\": [\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n },\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n }\n ],\n \"respondents\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"question\": {\n \"choiceCount\": \"\",\n \"type\": \"\",\n \"text\": \"\"\n },\n \"answerSummary\": [\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n },\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n }\n ],\n \"respondents\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n }\n }\n ],\n \"qas\": [\n {\n \"priority\": \"\",\n \"type\": \"\",\n \"displayName\": \"\",\n \"questionTime\": \"\",\n \"target\": \"\",\n \"question\": \"\",\n \"answers\": [\n {\n \"responseMode\": \"\",\n \"displayName\": \"\",\n \"correlationId\": \"\",\n \"email\": \"\",\n \"answerTime\": \"\",\n \"text\": \"\"\n },\n {\n \"responseMode\": \"\",\n \"displayName\": \"\",\n \"correlationId\": \"\",\n \"email\": \"\",\n \"answerTime\": \"\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"priority\": \"\",\n \"type\": \"\",\n \"displayName\": \"\",\n \"questionTime\": \"\",\n \"target\": \"\",\n \"question\": \"\",\n \"answers\": [\n {\n \"responseMode\": \"\",\n \"displayName\": \"\",\n \"correlationId\": \"\",\n \"email\": \"\",\n \"answerTime\": \"\",\n \"text\": \"\"\n },\n {\n \"responseMode\": \"\",\n \"displayName\": \"\",\n \"correlationId\": \"\",\n \"email\": \"\",\n \"answerTime\": \"\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"systemInfos\": [\n {\n \"displayName\": \"\",\n \"catalogs\": [\n {\n \"systemSummary\": \"\",\n \"browser\": \"\",\n \"hardware\": \"\",\n \"installedSoftware\": \"\",\n \"runningSoftware\": \"\",\n \"startupPrograms\": \"\",\n \"storage\": \"\",\n \"video\": \"\",\n \"network\": \"\",\n \"operatingSystem\": \"\",\n \"environmentVariables\": \"\",\n \"processes\": \"\",\n \"logicalDrives\": \"\",\n \"devices\": \"\",\n \"services\": \"\",\n \"systemDrivers\": \"\",\n \"signedDrivers\": \"\",\n \"eventViewer\": \"\",\n \"bios\": \"\"\n },\n {\n \"systemSummary\": \"\",\n \"browser\": \"\",\n \"hardware\": \"\",\n \"installedSoftware\": \"\",\n \"runningSoftware\": \"\",\n \"startupPrograms\": \"\",\n \"storage\": \"\",\n \"video\": \"\",\n \"network\": \"\",\n \"operatingSystem\": \"\",\n \"environmentVariables\": \"\",\n \"processes\": \"\",\n \"logicalDrives\": \"\",\n \"devices\": \"\",\n \"services\": \"\",\n \"systemDrivers\": \"\",\n \"signedDrivers\": \"\",\n \"eventViewer\": \"\",\n \"bios\": \"\"\n }\n ]\n },\n {\n \"displayName\": \"\",\n \"catalogs\": [\n {\n \"systemSummary\": \"\",\n \"browser\": \"\",\n \"hardware\": \"\",\n \"installedSoftware\": \"\",\n \"runningSoftware\": \"\",\n \"startupPrograms\": \"\",\n \"storage\": \"\",\n \"video\": \"\",\n \"network\": \"\",\n \"operatingSystem\": \"\",\n \"environmentVariables\": \"\",\n \"processes\": \"\",\n \"logicalDrives\": \"\",\n \"devices\": \"\",\n \"services\": \"\",\n \"systemDrivers\": \"\",\n \"signedDrivers\": \"\",\n \"eventViewer\": \"\",\n \"bios\": \"\"\n },\n {\n \"systemSummary\": \"\",\n \"browser\": \"\",\n \"hardware\": \"\",\n \"installedSoftware\": \"\",\n \"runningSoftware\": \"\",\n \"startupPrograms\": \"\",\n \"storage\": \"\",\n \"video\": \"\",\n \"network\": \"\",\n \"operatingSystem\": \"\",\n \"environmentVariables\": \"\",\n \"processes\": \"\",\n \"logicalDrives\": \"\",\n \"devices\": \"\",\n \"services\": \"\",\n \"systemDrivers\": \"\",\n \"signedDrivers\": \"\",\n \"eventViewer\": \"\",\n \"bios\": \"\"\n }\n ]\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json;charset=UTF-8" - } - ], - "name": "OK", + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [ { "description": "e.g. UTC", "key": "timezone", "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" } ], "method": "GET", @@ -48843,31 +48942,36 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "OK" + "status": "Forbidden" } ] - } - ], - "name": "Recording Report" - }, - { - "item": [ + }, { - "name": "List Recordings", + "name": "List Meeting Archive Summaries", "request": { - "description": "Lists recordings. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nOnly recordings of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. **NOTE**: when `meetingId` is specified, parameter of `siteUrl` will be ignored.\n\n* If `siteUrl` is specified, recordings of the specified site will be listed; otherwise, the API lists recordings of all the user's sites. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + "description": "Lists of meeting archive summaries. You can specify a date range and the maximum number of meeting archive summaries to return.\n\nMeeting archive summaries are only available to full administrators, not even the meeting host.\n\nThe list returned is sorted in descending order by the date and time that the archives were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the meeting archive summaries of the specified site will be listed; otherwise, meeting archive summaries of the user's preferred site will be listed. All available Webex sites and the preferred site of the user can be retrieved by the `Get Site List` API.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", "header": [ { "description": "e.g. UTC", @@ -48885,66 +48989,32 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, "response": [ @@ -48969,66 +49039,32 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, "status": "Too Many Requests" @@ -49054,66 +49090,32 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, "status": "Conflict" @@ -49121,10 +49123,10 @@ { "_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": { "header": [ { @@ -49139,77 +49141,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Unsupported Media Type" + "status": "Gateway Timeout" }, { "_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": [ { @@ -49224,77 +49192,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Unauthorized" + "status": "Gone" }, { "_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": [ { @@ -49309,77 +49243,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 500, "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": "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": [ { @@ -49394,101 +49294,49 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Not Found" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"EventCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"purged\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"SupportCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"available\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json;charset=UTF-8" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" - } - ], - "name": "OK", + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [ { "description": "e.g. UTC", "key": "timezone", "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" } ], "method": "GET", @@ -49497,77 +49345,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "OK" + "status": "Forbidden" }, { "_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": { "header": [ { @@ -49582,77 +49396,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Bad Gateway" + "status": "Service Unavailable" }, { "_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": [ { @@ -49667,77 +49447,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "key": "siteUrl", "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Service Unavailable" + "status": "Unauthorized" }, { "_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": [ { @@ -49752,83 +49498,67 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Forbidden" + "status": "Bad Gateway" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 400, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"archiveId\": \"\",\n \"serviceType\": \"SupportCenter\",\n \"title\": \"\",\n \"createTime\": \"\"\n },\n {\n \"archiveId\": \"\",\n \"serviceType\": \"MeetingCenter\",\n \"title\": \"\",\n \"createTime\": \"\"\n }\n ]\n}", + "code": 200, "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;charset=UTF-8" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { "header": [ { "description": "e.g. UTC", "key": "timezone", "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], "method": "GET", @@ -49837,77 +49567,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Bad Request" + "status": "OK" }, { "_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": [ { @@ -49922,77 +49618,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Precondition Required" + "status": "Unsupported Media Type" }, { "_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": [ { @@ -50007,77 +49669,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "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": [ { @@ -50092,77 +49720,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Method Not Allowed" + "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": { "header": [ { @@ -50177,77 +49771,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Gone" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": [ { @@ -50262,76 +49822,42 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Gateway Timeout" + "status": "Not Found" } ] }, { - "name": "List Recordings For an Admin or Compliance Officer", + "name": "Get Meeting Archive Details", "request": { - "description": "List recordings for an admin or compliance officer. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. Please note that when `meetingId` is specified, parameters of `siteUrl`, `from`, and `to` will be ignored.\n\n* If `siteUrl` is specified, all the recordings on the specified site are listed; otherwise, all the recordings on the admin user's or compliance officer's preferred site are listed. All the available Webex sites and the admin user's or compliance officer's preferred site can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + "description": "Retrieves details for a meeting archive report with a specified archive ID, which contains recording metadata.\n\nMeeting archive details are only available to full administrators, not even the meeting host.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", "header": [ { "description": "e.g. UTC", @@ -50349,72 +49875,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId", "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + ] } }, "response": [ { "_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": [ { @@ -50429,73 +49911,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + ] } }, - "status": "Service Unavailable" + "status": "Gone" }, { "_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": { "header": [ { @@ -50510,73 +49947,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_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": [ { @@ -50591,73 +49983,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + ] } }, - "status": "Unsupported Media Type" + "status": "Not Found" }, { "_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": { "header": [ { @@ -50672,73 +50019,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + ] } }, - "status": "Gone" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 429, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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": [ { @@ -50753,73 +50055,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_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": [ { @@ -50834,73 +50091,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + ] } }, - "status": "Not Found" + "status": "Bad Gateway" }, { "_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": [ { @@ -50915,73 +50127,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + ] } }, - "status": "Forbidden" + "status": "Precondition Required" }, { "_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": [ { @@ -50996,73 +50163,416 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordingReport", + "meetingArchives", + ":archiveId" + ], + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordingReport", + "meetingArchives", + ":archiveId" + ], + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - }, + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordingReport", + "meetingArchives", + ":archiveId" + ], + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" + } + ] + } + }, + "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": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordingReport", + "meetingArchives", + ":archiveId" + ], + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ + { + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "path": [ + "recordingReport", + "meetingArchives", + ":archiveId" + ], + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ + { + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" + } + ] } }, - "status": "Internal Server Error" + "status": "Gateway Timeout" }, { "_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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordingReport", + "meetingArchives", + ":archiveId" + ], + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ + { + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordingReport", + "meetingArchives", + ":archiveId" + ], + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ + { + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"archiveId\": \"\",\n \"serviceType\": \"MeetingCenter\",\n \"title\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"participants\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"joinedTime\": \"\",\n \"leftTime\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"joinedTime\": \"\",\n \"leftTime\": \"\",\n \"email\": \"\"\n }\n ],\n \"chats\": [\n {\n \"type\": \"\",\n \"senderName\": \"\",\n \"chatTime\": \"\",\n \"target\": \"\",\n \"text\": \"\"\n },\n {\n \"type\": \"\",\n \"senderName\": \"\",\n \"chatTime\": \"\",\n \"target\": \"\",\n \"text\": \"\"\n }\n ],\n \"polls\": [\n {\n \"type\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"content\": {\n \"questionCount\": \"\",\n \"userCount\": \"\",\n \"votedUserCount\": \"\",\n \"questions\": [\n {\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"question\": {\n \"choiceCount\": \"\",\n \"type\": \"\",\n \"text\": \"\"\n },\n \"answerSummary\": [\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n },\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n }\n ],\n \"respondents\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"question\": {\n \"choiceCount\": \"\",\n \"type\": \"\",\n \"text\": \"\"\n },\n \"answerSummary\": [\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n },\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n }\n ],\n \"respondents\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n }\n },\n {\n \"type\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"content\": {\n \"questionCount\": \"\",\n \"userCount\": \"\",\n \"votedUserCount\": \"\",\n \"questions\": [\n {\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"question\": {\n \"choiceCount\": \"\",\n \"type\": \"\",\n \"text\": \"\"\n },\n \"answerSummary\": [\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n },\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n }\n ],\n \"respondents\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"question\": {\n \"choiceCount\": \"\",\n \"type\": \"\",\n \"text\": \"\"\n },\n \"answerSummary\": [\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n },\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n }\n ],\n \"respondents\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n }\n }\n ],\n \"qas\": [\n {\n \"priority\": \"\",\n \"type\": \"\",\n \"displayName\": \"\",\n \"questionTime\": \"\",\n \"target\": \"\",\n \"question\": \"\",\n \"answers\": [\n {\n \"responseMode\": \"\",\n \"displayName\": \"\",\n \"correlationId\": \"\",\n \"email\": \"\",\n \"answerTime\": \"\",\n \"text\": \"\"\n },\n {\n \"responseMode\": \"\",\n \"displayName\": \"\",\n \"correlationId\": \"\",\n \"email\": \"\",\n \"answerTime\": \"\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"priority\": \"\",\n \"type\": \"\",\n \"displayName\": \"\",\n \"questionTime\": \"\",\n \"target\": \"\",\n \"question\": \"\",\n \"answers\": [\n {\n \"responseMode\": \"\",\n \"displayName\": \"\",\n \"correlationId\": \"\",\n \"email\": \"\",\n \"answerTime\": \"\",\n \"text\": \"\"\n },\n {\n \"responseMode\": \"\",\n \"displayName\": \"\",\n \"correlationId\": \"\",\n \"email\": \"\",\n \"answerTime\": \"\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"systemInfos\": [\n {\n \"displayName\": \"\",\n \"catalogs\": [\n {\n \"systemSummary\": \"\",\n \"browser\": \"\",\n \"hardware\": \"\",\n \"installedSoftware\": \"\",\n \"runningSoftware\": \"\",\n \"startupPrograms\": \"\",\n \"storage\": \"\",\n \"video\": \"\",\n \"network\": \"\",\n \"operatingSystem\": \"\",\n \"environmentVariables\": \"\",\n \"processes\": \"\",\n \"logicalDrives\": \"\",\n \"devices\": \"\",\n \"services\": \"\",\n \"systemDrivers\": \"\",\n \"signedDrivers\": \"\",\n \"eventViewer\": \"\",\n \"bios\": \"\"\n },\n {\n \"systemSummary\": \"\",\n \"browser\": \"\",\n \"hardware\": \"\",\n \"installedSoftware\": \"\",\n \"runningSoftware\": \"\",\n \"startupPrograms\": \"\",\n \"storage\": \"\",\n \"video\": \"\",\n \"network\": \"\",\n \"operatingSystem\": \"\",\n \"environmentVariables\": \"\",\n \"processes\": \"\",\n \"logicalDrives\": \"\",\n \"devices\": \"\",\n \"services\": \"\",\n \"systemDrivers\": \"\",\n \"signedDrivers\": \"\",\n \"eventViewer\": \"\",\n \"bios\": \"\"\n }\n ]\n },\n {\n \"displayName\": \"\",\n \"catalogs\": [\n {\n \"systemSummary\": \"\",\n \"browser\": \"\",\n \"hardware\": \"\",\n \"installedSoftware\": \"\",\n \"runningSoftware\": \"\",\n \"startupPrograms\": \"\",\n \"storage\": \"\",\n \"video\": \"\",\n \"network\": \"\",\n \"operatingSystem\": \"\",\n \"environmentVariables\": \"\",\n \"processes\": \"\",\n \"logicalDrives\": \"\",\n \"devices\": \"\",\n \"services\": \"\",\n \"systemDrivers\": \"\",\n \"signedDrivers\": \"\",\n \"eventViewer\": \"\",\n \"bios\": \"\"\n },\n {\n \"systemSummary\": \"\",\n \"browser\": \"\",\n \"hardware\": \"\",\n \"installedSoftware\": \"\",\n \"runningSoftware\": \"\",\n \"startupPrograms\": \"\",\n \"storage\": \"\",\n \"video\": \"\",\n \"network\": \"\",\n \"operatingSystem\": \"\",\n \"environmentVariables\": \"\",\n \"processes\": \"\",\n \"logicalDrives\": \"\",\n \"devices\": \"\",\n \"services\": \"\",\n \"systemDrivers\": \"\",\n \"signedDrivers\": \"\",\n \"eventViewer\": \"\",\n \"bios\": \"\"\n }\n ]\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json;charset=UTF-8" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordingReport", + "meetingArchives", + ":archiveId" + ], + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ + { + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" + } + ] + } + }, + "status": "OK" + } + ] + } + ], + "name": "Recording Report" + }, + { + "item": [ + { + "name": "List Recordings", + "request": { + "description": "
This API is still supported and behaves the same as before, but will be deprecated in the future. Due to limited support for special characters when filtering recordings by `topic`, it is recommended to use the new [Query Recordings](/docs/api/v1/recordings/query-recordings) API instead.
\n\nLists recordings. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nOnly recordings of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. **NOTE**: when `meetingId` is specified, parameter of `siteUrl` will be ignored.\n\n* If `siteUrl` is specified, recordings of the specified site will be listed; otherwise, the API lists recordings of all the user's sites. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "response": [ + { + "_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": [ { @@ -51077,7 +50587,6 @@ "{{baseUrl}}" ], "path": [ - "admin", "recordings" ], "query": [ @@ -51087,32 +50596,37 @@ "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", "key": "meetingId", "value": "" }, { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" }, { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", "key": "integrationTag", "value": "" }, { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", "key": "topic", "value": "" }, @@ -51122,28 +50636,28 @@ "value": "MP4" }, { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", "key": "serviceType", "value": "SupportCenter" }, { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", "key": "status", "value": "available" } ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" } }, - "status": "Bad Gateway" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 409, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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": [ { @@ -51158,7 +50672,6 @@ "{{baseUrl}}" ], "path": [ - "admin", "recordings" ], "query": [ @@ -51168,32 +50681,37 @@ "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", "key": "meetingId", "value": "" }, { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" }, { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", "key": "integrationTag", "value": "" }, { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", "key": "topic", "value": "" }, @@ -51203,28 +50721,28 @@ "value": "MP4" }, { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", "key": "serviceType", "value": "SupportCenter" }, { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", "key": "status", "value": "available" } ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" } }, - "status": "Bad Request" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 415, "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": "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": [ { @@ -51239,7 +50757,6 @@ "{{baseUrl}}" ], "path": [ - "admin", "recordings" ], "query": [ @@ -51249,32 +50766,37 @@ "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", "key": "meetingId", "value": "" }, { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" }, { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", "key": "integrationTag", "value": "" }, { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", "key": "topic", "value": "" }, @@ -51284,28 +50806,28 @@ "value": "MP4" }, { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", "key": "serviceType", "value": "SupportCenter" }, { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", "key": "status", "value": "available" } ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 401, "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": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [ { @@ -51320,7 +50842,6 @@ "{{baseUrl}}" ], "path": [ - "admin", "recordings" ], "query": [ @@ -51330,32 +50851,37 @@ "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", "key": "meetingId", "value": "" }, { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" }, { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", "key": "integrationTag", "value": "" }, { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", "key": "topic", "value": "" }, @@ -51365,28 +50891,28 @@ "value": "MP4" }, { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", "key": "serviceType", "value": "SupportCenter" }, { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", "key": "status", "value": "available" } ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" } }, - "status": "Conflict" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 423, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "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": [ { @@ -51401,7 +50927,6 @@ "{{baseUrl}}" ], "path": [ - "admin", "recordings" ], "query": [ @@ -51411,32 +50936,37 @@ "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", "key": "meetingId", "value": "" }, { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" }, { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", "key": "integrationTag", "value": "" }, { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", "key": "topic", "value": "" }, @@ -51446,28 +50976,28 @@ "value": "MP4" }, { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", "key": "serviceType", "value": "SupportCenter" }, { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", "key": "status", "value": "available" } ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" } }, - "status": "Method Not Allowed" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": [ { @@ -51482,7 +51012,6 @@ "{{baseUrl}}" ], "path": [ - "admin", "recordings" ], "query": [ @@ -51492,32 +51021,37 @@ "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", "key": "meetingId", "value": "" }, { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" }, { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", "key": "integrationTag", "value": "" }, { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", "key": "topic", "value": "" }, @@ -51527,24 +51061,24 @@ "value": "MP4" }, { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", "key": "serviceType", "value": "SupportCenter" }, { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", "key": "status", "value": "available" } ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" } }, - "status": "Gateway Timeout" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"MeetingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"status\": \"deleted\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"EventCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"status\": \"deleted\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"EventCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"purged\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"SupportCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"available\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -51581,7 +51115,6 @@ "{{baseUrl}}" ], "path": [ - "admin", "recordings" ], "query": [ @@ -51591,32 +51124,37 @@ "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", "key": "meetingId", "value": "" }, { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" }, { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", "key": "integrationTag", "value": "" }, { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", "key": "topic", "value": "" }, @@ -51626,17 +51164,17 @@ "value": "MP4" }, { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", "key": "serviceType", "value": "SupportCenter" }, { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", "key": "status", "value": "available" } ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" } }, "status": "OK" @@ -51644,10 +51182,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 502, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [ { @@ -51662,7 +51200,6 @@ "{{baseUrl}}" ], "path": [ - "admin", "recordings" ], "query": [ @@ -51672,32 +51209,37 @@ "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", "key": "meetingId", "value": "" }, { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" }, { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", "key": "integrationTag", "value": "" }, { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", "key": "topic", "value": "" }, @@ -51707,288 +51249,5668 @@ "value": "MP4" }, { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", "key": "serviceType", "value": "SupportCenter" }, { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", "key": "status", "value": "available" } ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" } }, - "status": "Precondition Required" - } - ] - }, - { - "name": "Delete a Recording By an Admin", - "request": { - "description": "Removes a recording with a specified recording ID by an admin. The deleted recording cannot be recovered. It will be inaccessible to regular users (host, attendees and shared) or an admin, but it will be still available to the Compliance Officer.\n\nAny recording on a site which is managed by the admin can be deleted by him.\n\nThe `temporaryDirectDownloadLinks` of a recording which are retrieved by the [Get Recording Details](/docs/api/v1/recordings/get-recording-details) API are still available to Compliance Officers even if the recording has been deleted.", - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "recordings", - ":recordingId" - ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] - } - }, - "response": [ + "status": "Bad Gateway" + }, { "_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": "DELETE", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "recordings", - ":recordingId" + "recordings" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" } - ] + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" } }, - "status": "Gone" + "status": "Service Unavailable" }, { "_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": "DELETE", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "recordings", - ":recordingId" + "recordings" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" } - ] + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_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", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "recordings", - ":recordingId" + "recordings" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" } - ] + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" } }, - "status": "No Content" + "status": "Bad Request" }, { "_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", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "recordings", - ":recordingId" + "recordings" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" } - ] + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" } }, - "status": "Service Unavailable" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 500, "cookie": [], "header": [], - "name": "Not Found", + "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", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "recordings", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "status": "Gateway Timeout" + } + ] + }, + { + "name": "List Recordings For an Admin or Compliance Officer", + "request": { + "description": "
This API is still supported and behaves the same as before, but will be deprecated in the future. Due to limited support for special characters when filtering recordings by `topic`, it is recommended to use the new [Query Recordings For an Admin or Compliance Officer](/docs/api/v1/recordings/query-recordings-for-an-admin-or-compliance-officer) API instead.
\n\nList recordings for an admin or compliance officer. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. Please note that when `meetingId` is specified, parameters of `siteUrl`, `from`, and `to` will be ignored.\n\n* If `siteUrl` is specified, all the recordings on the specified site are listed; otherwise, all the recordings on the admin user's or compliance officer's preferred site are listed. All the available Webex sites and the admin user's or compliance officer's preferred site can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "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": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "status": "Bad Request" + }, + { + "_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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "status": "Conflict" + }, + { + "_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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"MeetingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"status\": \"deleted\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"EventCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"status\": \"deleted\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json;charset=UTF-8" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=SupportCenter&status=available" + } + }, + "status": "Precondition Required" + } + ] + }, + { + "name": "Delete a Recording By an Admin", + "request": { + "description": "Removes a recording with a specified recording ID by an admin. The deleted recording cannot be recovered. It will be inaccessible to regular users (host, attendees and shared) or an admin, but it will be still available to the Compliance Officer.\n\nAny recording on a site which is managed by the admin can be deleted by him.\n\nThe `temporaryDirectDownloadLinks` of a recording which are retrieved by the [Get Recording Details](/docs/api/v1/recordings/get-recording-details) API are still available to Compliance Officers even if the recording has been deleted.", + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] + } + }, + "response": [ + { + "_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": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "No Content" + }, + { + "_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": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_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": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_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": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "Get Recording Details", + "request": { + "description": "Retrieves details for a recording with a specified recording ID.\n\nOnly recordings of meetings hosted by or shared with the authenticated user may be retrieved.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*\n\n* `siteUrl`: Optional request header parameter. If specified, retrieve the recording details from that site; otherwise, retrieve it from the site which is implied based on the recording ID.", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "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": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"SupportCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"available\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"temporaryDirectDownloadLinks\": {\n \"recordingDownloadLink\": \"\",\n \"audioDownloadLink\": \"\",\n \"transcriptDownloadLink\": \"\",\n \"expiration\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json;charset=UTF-8" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Gone" + }, + { + "_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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "Delete a Recording", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "description": "Removes a recording with a specified recording ID. The deleted recording cannot be recovered. If a Compliance Officer deletes another user's recording, the recording will be inaccessible to regular users (host, attendees and shared), but will be still available to the Compliance Officer.\n\nOnly recordings of meetings hosted by the authenticated user can be deleted.\n\nThe `temporaryDirectDownloadLinks` of a recording which are retrieved by the [Get Recording Details](/docs/api/v1/recordings/get-recording-details) API are still available to Compliance Officers even if the recording has been deleted.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "No Content" + }, + { + "_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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", ":recordingId" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "Move Recordings into the Recycle Bin", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "description": "Move recordings into the recycle bin with recording IDs. Recordings in the recycle bin can be recovered by [Restore Recordings from Recycle Bin](/docs/api/v1/recordings/restore-recordings-from-recycle-bin) API. If you'd like to empty recordings from the recycle bin, you can use [Purge Recordings from Recycle Bin](/docs/api/v1/recordings/purge-recordings-from-recycle-bin) API to purge all or some of them.\n\nOnly recordings of meetings hosted by the authenticated user can be moved into the recycle bin.\n\n* `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "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 \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "status": "Bad Gateway" + }, + { + "_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 \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "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": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "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 \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "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 \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "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 \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "status": "No Content" + }, + { + "_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 \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "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": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "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": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "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": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_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 \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "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 \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "softDelete" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + } + }, + "status": "Conflict" + } + ] + }, + { + "name": "Restore Recordings from Recycle Bin", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "description": "Restore all or some recordings from the recycle bin. Only recordings of meetings hosted by the authenticated user can be restored from recycle bin.\n\n* If `restoreAll` is `true`, `recordingIds` should be empty.\n\n* If `restoreAll` is `false`, `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "restore" + ], + "query": [ + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + } + }, + "response": [ + { + "_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 \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "restore" + ], + "query": [ + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + } + }, + "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 \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "restore" + ], + "query": [ + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "restore" + ], + "query": [ + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + } + }, + "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 \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "restore" + ], + "query": [ + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "restore" + ], + "query": [ + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + } + }, + "status": "Unsupported Media Type" + }, + { + "_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 \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "restore" + ], + "query": [ + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + } + }, + "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 \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "restore" + ], + "query": [ + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + } + }, + "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 \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "restore" + ], + "query": [ + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + } + }, + "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": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "restore" + ], + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Not Found" + "status": "Gateway Timeout" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", - ":recordingId" + "restore" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Precondition Required" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", - ":recordingId" + "restore" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Bad Request" + "status": "Unauthorized" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", - ":recordingId" + "restore" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Method Not Allowed" + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "restore" + ], + "query": [ + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + } + }, + "status": "Bad Request" }, { "_postman_previewlanguage": "text", @@ -51998,24 +56920,39 @@ "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", - ":recordingId" + "restore" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, "status": "Bad Gateway" @@ -52023,402 +56960,584 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 423, "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": "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 \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", - ":recordingId" + "restore" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Unsupported Media Type" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 204, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "No Content", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", - ":recordingId" + "restore" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", + "key": "hostEmail", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Precondition Required" + "status": "No Content" + } + ] + }, + { + "name": "Purge Recordings from Recycle Bin", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, + "description": "Purge recordings from recycle bin with recording IDs or purge all the recordings that are in the recycle bin.\n\nOnly recordings of meetings hosted by the authenticated user can be purged from recycle bin.\n\n* If `purgeAll` is `true`, `recordingIds` should be empty.\n\n* If `purgeAll` is `false`, `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "purge" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + } + }, + "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 400, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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 \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", - ":recordingId" + "purge" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", + "key": "hostEmail", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Forbidden" + "status": "Bad Request" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", - ":recordingId" + "purge" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "purge" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "purge" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", + "key": "hostEmail", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Conflict" + "status": "Not Found" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", - ":recordingId" + "purge" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", + "key": "hostEmail", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Gateway Timeout" + "status": "Internal Server Error" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", - ":recordingId" + "purge" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", + "key": "hostEmail", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Internal Server Error" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 502, "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": "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 \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", - ":recordingId" + "purge" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", + "key": "hostEmail", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Too Many Requests" - } - ] - }, - { - "name": "Get Recording Details", - "request": { - "description": "Retrieves details for a recording with a specified recording ID.\n\nOnly recordings of meetings hosted by or shared with the authenticated user may be retrieved.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*\n\n* `siteUrl`: Optional request header parameter. If specified, retrieve the recording details from that site; otherwise, retrieve it from the site which is implied based on the recording ID.", - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - } - ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] - } - }, - "response": [ + "status": "Bad Gateway" + }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Unsupported Media Type" + "status": "Gone" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 429, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", @@ -52428,41 +57547,39 @@ "header": [], "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, "status": "Service Unavailable" @@ -52475,147 +57592,177 @@ "header": [], "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, "status": "Precondition Required" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"SupportCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"available\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"temporaryDirectDownloadLinks\": {\n \"recordingDownloadLink\": \"\",\n \"audioDownloadLink\": \"\",\n \"transcriptDownloadLink\": \"\",\n \"expiration\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 409, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json;charset=UTF-8" - } - ], - "name": "OK", + "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "key": "Accept", - "value": "application/json;charset=UTF-8" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "OK" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 204, "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": "No Content", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + } + }, + "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 \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "purge" + ], + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", + "key": "hostEmail", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -52625,82 +57772,121 @@ "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, "status": "Gateway Timeout" + } + ] + }, + { + "name": "Share a Recording", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, + "description": "Share or unshare a recording with other users by recording ID and email addresses.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId", + "accessList" + ], + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] + } + }, + "response": [ { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - } + ":recordingId", + "accessList" ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", "variable": [ { "description": "A unique identifier for the recording.", @@ -52709,45 +57895,43 @@ ] } }, - "status": "Method Not Allowed" + "status": "Conflict" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - } + ":recordingId", + "accessList" ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", "variable": [ { "description": "A unique identifier for the recording.", @@ -52756,45 +57940,43 @@ ] } }, - "status": "Bad Gateway" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 504, "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": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - } + ":recordingId", + "accessList" ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", "variable": [ { "description": "A unique identifier for the recording.", @@ -52803,45 +57985,43 @@ ] } }, - "status": "Not Found" + "status": "Gateway Timeout" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - } + ":recordingId", + "accessList" ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", "variable": [ { "description": "A unique identifier for the recording.", @@ -52850,45 +58030,43 @@ ] } }, - "status": "Gone" + "status": "Service Unavailable" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - } + ":recordingId", + "accessList" ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", "variable": [ { "description": "A unique identifier for the recording.", @@ -52897,45 +58075,43 @@ ] } }, - "status": "Conflict" + "status": "Precondition Required" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - } + ":recordingId", + "accessList" ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", "variable": [ { "description": "A unique identifier for the recording.", @@ -52944,45 +58120,43 @@ ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - } + ":recordingId", + "accessList" ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", "variable": [ { "description": "A unique identifier for the recording.", @@ -52991,45 +58165,43 @@ ] } }, - "status": "Internal Server Error" + "status": "Method Not Allowed" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - } + ":recordingId", + "accessList" ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", "variable": [ { "description": "A unique identifier for the recording.", @@ -53038,64 +58210,15 @@ ] } }, - "status": "Too Many Requests" - } - ] - }, - { - "name": "Delete a Recording", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "status": "Gone" }, - "description": "Removes a recording with a specified recording ID. The deleted recording cannot be recovered. If a Compliance Officer deletes another user's recording, the recording will be inaccessible to regular users (host, attendees and shared), but will be still available to the Compliance Officer.\n\nOnly recordings of meetings hosted by the authenticated user can be deleted.\n\nThe `temporaryDirectDownloadLinks` of a recording which are retrieved by the [Get Recording Details](/docs/api/v1/recordings/get-recording-details) API are still available to Compliance Officers even if the recording has been deleted.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", - "value": "" - } - ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] - } - }, - "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 415, "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": "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", @@ -53105,7 +58228,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -53113,23 +58236,17 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", - "value": "" - } + ":recordingId", + "accessList" ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", "variable": [ { "description": "A unique identifier for the recording.", @@ -53138,15 +58255,15 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 502, "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 Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -53156,7 +58273,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -53164,23 +58281,17 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", - "value": "" - } + ":recordingId", + "accessList" ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", "variable": [ { "description": "A unique identifier for the recording.", @@ -53189,7 +58300,7 @@ ] } }, - "status": "Gateway Timeout" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", @@ -53207,7 +58318,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -53215,23 +58326,17 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", - "value": "" - } + ":recordingId", + "accessList" ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", "variable": [ { "description": "A unique identifier for the recording.", @@ -53245,10 +58350,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 204, "cookie": [], "header": [], - "name": "Not Found", + "name": "No Content", "originalRequest": { "body": { "mode": "raw", @@ -53258,7 +58363,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -53266,23 +58371,17 @@ "value": "application/json" } ], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", - "value": "" - } + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "path": [ + "recordings", + ":recordingId", + "accessList" + ], + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", "variable": [ { "description": "A unique identifier for the recording.", @@ -53291,15 +58390,15 @@ ] } }, - "status": "Not Found" + "status": "No Content" }, { "_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", @@ -53309,7 +58408,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -53317,23 +58416,17 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", - "value": "" - } + ":recordingId", + "accessList" ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", "variable": [ { "description": "A unique identifier for the recording.", @@ -53342,15 +58435,15 @@ ] } }, - "status": "Gone" + "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", @@ -53360,7 +58453,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -53368,23 +58461,17 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", - "value": "" - } + ":recordingId", + "accessList" ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", "variable": [ { "description": "A unique identifier for the recording.", @@ -53393,15 +58480,15 @@ ] } }, - "status": "Service Unavailable" + "status": "Too Many Requests" }, { "_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": { "body": { "mode": "raw", @@ -53411,7 +58498,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -53419,23 +58506,17 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", - "value": "" - } + ":recordingId", + "accessList" ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", "variable": [ { "description": "A unique identifier for the recording.", @@ -53444,7 +58525,7 @@ ] } }, - "status": "Precondition Required" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -53462,7 +58543,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -53470,23 +58551,17 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", - "value": "" - } + ":recordingId", + "accessList" ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", "variable": [ { "description": "A unique identifier for the recording.", @@ -53496,261 +58571,463 @@ } }, "status": "Internal Server Error" - }, + } + ] + }, + { + "name": "List Group Recordings", + "request": { + "description": "List group recordings for a service app which has group recording access. You can specify a date range, the maximum number of recordings to return, and `personId` or `hostEmail` of whom the recordings will be retrieved.\n\n* The list returned is sorted in descending order by the date and time that the recordings were created.\n\n* Only recordings which are in the `available` status and not shared by others can be listed. Those in the `deleted` or `purged` status or shared by others can't be listed.\n\n* Long result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the API lists group recordings on the specified site; otherwise, the API lists group recordings on all the sites managed by the service app. All the sites managed by a service app can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* One of the `personId` parameter and `hostEmail` header must be specified so that only recordings of meetings hosted by the person of `personId` or `hostEmail` will be returned.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.\n\n* `hostEmail`: Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "group", + "recordings" + ], + "query": [ + { + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + } + ], + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" + } + }, + "response": [ { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - ":recordingId" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" - } - ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" } - ] + ], + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" } }, - "status": "Forbidden" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 502, "cookie": [], "header": [], - "name": "No Content", + "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 \"reason\": \"\",\n \"comment\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - ":recordingId" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" - } - ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" } - ] + ], + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" } }, - "status": "No Content" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 423, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "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 \"reason\": \"\",\n \"comment\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - ":recordingId" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" - } - ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" } - ] + ], + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" } }, - "status": "Method Not Allowed" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - ":recordingId" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" - } - ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" } - ] + ], + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" } }, - "status": "Unauthorized" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 400, "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 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 \"reason\": \"\",\n \"comment\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - ":recordingId" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" - } - ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" } - ] + ], + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" } }, - "status": "Conflict" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", @@ -53760,45 +59037,70 @@ "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 \"reason\": \"\",\n \"comment\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - ":recordingId" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" - } - ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" } - ] + ], + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" } }, "status": "Unsupported Media Type" @@ -53806,236 +59108,306 @@ { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - ":recordingId" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" - } - ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" } - ] + ], + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" } }, - "status": "Bad Gateway" + "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 \"reason\": \"\",\n \"comment\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - ":recordingId" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" - } - ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" } - ] - } - }, - "status": "Too Many Requests" - } - ] - }, - { - "name": "Move Recordings into the Recycle Bin", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + ], + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "status": "Internal Server Error" }, - "description": "Move recordings into the recycle bin with recording IDs. Recordings in the recycle bin can be recovered by [Restore Recordings from Recycle Bin](/docs/api/v1/recordings/restore-recordings-from-recycle-bin) API. If you'd like to empty recordings from the recycle bin, you can use [Purge Recordings from Recycle Bin](/docs/api/v1/recordings/purge-recordings-from-recycle-bin) API to purge all or some of them.\n\nOnly recordings of meetings hosted by the authenticated user can be moved into the recycle bin.\n\n* `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "recordings", - "softDelete" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", - "value": "" - } - ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" - } - }, - "response": [ { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "softDelete" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" } }, - "status": "Service Unavailable" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 428, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "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 \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "softDelete" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" } }, - "status": "Bad Gateway" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", @@ -54045,39 +59417,70 @@ "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 \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "softDelete" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" } }, "status": "Gateway Timeout" @@ -54085,674 +59488,900 @@ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "softDelete" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" } }, - "status": "Bad Request" + "status": "Not Found" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "softDelete" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" } }, - "status": "Forbidden" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 401, "cookie": [], "header": [], - "name": "Not Found", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "softDelete" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" } }, - "status": "Not Found" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 410, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"MeetingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"deleted\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"SupportCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"purged\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n }\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 \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "header": [ + { + "key": "Content-Type", + "value": "application/json;charset=UTF-8" }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", + "originalRequest": { "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "softDelete" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" } }, - "status": "Gone" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 403, "cookie": [], "header": [], - "name": "No Content", + "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 \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "softDelete" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=EventCenter" } }, - "status": "No Content" - }, + "status": "Forbidden" + } + ] + }, + { + "name": "Get Group Recording Details", + "request": { + "description": "Retrieves details for a group recording for a service app which has group recording access.\n\n* Only recordings which are in the `available` status and not shared by others can be listed. Those in the `deleted` or `purged` status or shared by others can't be listed.\n\n* One of the `personId` parameter and `hostEmail` header must be specified so that only recordings of meetings hosted by the person of `personId` or `hostEmail` will be returned.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*\n\n* `hostEmail`: Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "group", + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 401, "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": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - "softDelete" + ":recordingId" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_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.", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - "softDelete" + ":recordingId" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] } }, - "status": "Precondition Required" + "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - "softDelete" + ":recordingId" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] } }, - "status": "Method Not Allowed" + "status": "Too Many Requests" }, { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - "softDelete" + ":recordingId" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] } }, - "status": "Too Many Requests" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 500, "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": "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 \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - "softDelete" + ":recordingId" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Internal Server Error" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - "softDelete" + ":recordingId" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] } }, - "status": "Unauthorized" + "status": "Gateway Timeout" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 415, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"MeetingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"available\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"temporaryDirectDownloadLinks\": {\n \"recordingDownloadLink\": \"\",\n \"audioDownloadLink\": \"\",\n \"transcriptDownloadLink\": \"\",\n \"expiration\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ]\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;charset=UTF-8" + } + ], + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - "softDelete" + ":recordingId" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] } }, - "status": "Unsupported Media Type" + "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - "softDelete" + ":recordingId" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" - } - }, - "status": "Conflict" - } - ] - }, - { - "name": "Restore Recordings from Recycle Bin", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "status": "Precondition Required" }, - "description": "Restore all or some recordings from the recycle bin. Only recordings of meetings hosted by the authenticated user can be restored from recycle bin.\n\n* If `restoreAll` is `true`, `recordingIds` should be empty.\n\n* If `restoreAll` is `false`, `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "recordings", - "restore" - ], - "query": [ - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" - } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" - } - }, - "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 415, "cookie": [], "header": [], - "name": "Not Found", + "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 \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - "restore" + ":recordingId" ], "query": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] } }, - "status": "Not Found" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", @@ -54762,39 +60391,43 @@ "header": [], "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - "restore" + ":recordingId" ], "query": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] } }, "status": "Gone" @@ -54802,280 +60435,339 @@ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - "restore" + ":recordingId" ], "query": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] } }, - "status": "Internal Server Error" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 502, "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": "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 \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - "restore" + ":recordingId" ], "query": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] } }, - "status": "Too Many Requests" + "status": "Bad Gateway" }, { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - "restore" + ":recordingId" ], "query": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] } }, - "status": "Unsupported Media Type" + "status": "Service Unavailable" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - "restore" + ":recordingId" ], "query": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] } }, - "status": "Service Unavailable" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 423, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "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 \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - "restore" + ":recordingId" ], "query": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] } }, - "status": "Method Not Allowed" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 400, "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 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 \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - "restore" + ":recordingId" ], "query": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] } }, - "status": "Conflict" + "status": "Bad Request" + } + ] + }, + { + "name": "Share a Recording Link", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, + "description": "Share or unshare a recording with other users by recording link and email addresses.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "accessList" + ], + "raw": "{{baseUrl}}/recordings/accessList" + } + }, + "response": [ { "_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": { "body": { "mode": "raw", @@ -55085,7 +60777,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -55100,27 +60792,20 @@ ], "path": [ "recordings", - "restore" - ], - "query": [ - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" - } + "accessList" ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Gateway Timeout" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 204, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "No Content", "originalRequest": { "body": { "mode": "raw", @@ -55130,7 +60815,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -55145,27 +60830,20 @@ ], "path": [ "recordings", - "restore" - ], - "query": [ - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" - } + "accessList" ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Precondition Required" + "status": "No Content" }, { "_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": { "body": { "mode": "raw", @@ -55175,7 +60853,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -55190,27 +60868,20 @@ ], "path": [ "recordings", - "restore" - ], - "query": [ - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" - } + "accessList" ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Unauthorized" + "status": "Gateway Timeout" }, { "_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", @@ -55220,7 +60891,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -55235,27 +60906,20 @@ ], "path": [ "recordings", - "restore" - ], - "query": [ - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" - } + "accessList" ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Forbidden" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 405, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -55265,7 +60929,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -55280,27 +60944,20 @@ ], "path": [ "recordings", - "restore" - ], - "query": [ - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" - } + "accessList" ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Bad Request" + "status": "Method Not Allowed" }, { "_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": "raw", @@ -55310,7 +60967,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -55325,27 +60982,20 @@ ], "path": [ "recordings", - "restore" - ], - "query": [ - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" - } + "accessList" ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Bad Gateway" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 404, "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": "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", @@ -55355,7 +61005,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -55370,27 +61020,20 @@ ], "path": [ "recordings", - "restore" - ], - "query": [ - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" - } + "accessList" ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 429, "cookie": [], "header": [], - "name": "No Content", + "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", @@ -55400,7 +61043,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -55415,69 +61058,20 @@ ], "path": [ "recordings", - "restore" - ], - "query": [ - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" - } + "accessList" ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" - } - }, - "status": "No Content" - } - ] - }, - { - "name": "Purge Recordings from Recycle Bin", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "status": "Too Many Requests" }, - "description": "Purge recordings from recycle bin with recording IDs or purge all the recordings that are in the recycle bin.\n\nOnly recordings of meetings hosted by the authenticated user can be purged from recycle bin.\n\n* If `purgeAll` is `true`, `recordingIds` should be empty.\n\n* If `purgeAll` is `false`, `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "recordings", - "purge" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } - ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" - } - }, - "response": [ { "_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": { "body": { "mode": "raw", @@ -55487,7 +61081,7 @@ "language": "json" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -55502,27 +61096,20 @@ ], "path": [ "recordings", - "purge" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } + "accessList" ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Bad Request" + "status": "Service Unavailable" }, { "_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", @@ -55532,7 +61119,7 @@ "language": "json" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -55547,27 +61134,20 @@ ], "path": [ "recordings", - "purge" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } + "accessList" ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Method Not Allowed" + "status": "Unsupported Media Type" }, { "_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": { "body": { "mode": "raw", @@ -55577,7 +61157,7 @@ "language": "json" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -55592,27 +61172,20 @@ ], "path": [ "recordings", - "purge" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } + "accessList" ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 428, "cookie": [], "header": [], - "name": "Not Found", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "body": { "mode": "raw", @@ -55622,7 +61195,7 @@ "language": "json" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -55637,27 +61210,20 @@ ], "path": [ "recordings", - "purge" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } + "accessList" ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Not Found" + "status": "Precondition Required" }, { "_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", @@ -55667,7 +61233,7 @@ "language": "json" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -55682,27 +61248,20 @@ ], "path": [ "recordings", - "purge" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } + "accessList" ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Internal Server Error" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", @@ -55712,7 +61271,7 @@ "language": "json" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -55727,27 +61286,20 @@ ], "path": [ "recordings", - "purge" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } + "accessList" ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Unsupported Media Type" + "status": "Gone" }, { "_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": { "body": { "mode": "raw", @@ -55757,7 +61309,7 @@ "language": "json" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -55772,27 +61324,20 @@ ], "path": [ "recordings", - "purge" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } + "accessList" ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Bad Gateway" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 400, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "body": { "mode": "raw", @@ -55802,7 +61347,7 @@ "language": "json" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -55817,27 +61362,64 @@ ], "path": [ "recordings", - "purge" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } + "accessList" ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Gone" + "status": "Bad Request" + } + ] + }, + { + "name": "Query Recordings", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, + "description": "Queries recordings with filters in the request body. You can specify a date range, a parent meeting ID, the maximum number of recordings to return, and additional filters such as siteUrl, integrationTag, hostEmail, topic, format, serviceType, and status.\n\nOnly recordings of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. **NOTE**: when `meetingId` is specified, parameter of `siteUrl` will be ignored.\n\n* If `siteUrl` is specified, recordings of the specified site will be listed; otherwise, the API lists recordings of all the user's sites. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "query" + ], + "raw": "{{baseUrl}}/recordings/query" + } + }, + "response": [ { "_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", @@ -55847,9 +61429,14 @@ "language": "json" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -55862,27 +61449,20 @@ ], "path": [ "recordings", - "purge" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_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": "raw", @@ -55892,9 +61472,14 @@ "language": "json" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -55907,27 +61492,20 @@ ], "path": [ "recordings", - "purge" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Too Many Requests" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 502, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -55937,9 +61515,14 @@ "language": "json" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -55952,27 +61535,20 @@ ], "path": [ "recordings", - "purge" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Service Unavailable" + "status": "Bad Gateway" }, { "_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", @@ -55982,9 +61558,14 @@ "language": "json" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -55997,27 +61578,20 @@ ], "path": [ "recordings", - "purge" + "query" ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } - ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Precondition Required" + "status": "Not Found" }, { "_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", @@ -56027,9 +61601,14 @@ "language": "json" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56042,27 +61621,20 @@ ], "path": [ "recordings", - "purge" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Conflict" + "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", @@ -56072,9 +61644,14 @@ "language": "json" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56087,27 +61664,34 @@ ], "path": [ "recordings", - "purge" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "No Content" + "status": "Gone" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"EventCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"deleted\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"SupportCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"deleted\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "header": [ + { + "key": "Content-Type", + "value": "application/json;charset=UTF-8" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -56117,12 +61701,21 @@ "language": "json" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], "method": "POST", @@ -56132,27 +61725,20 @@ ], "path": [ "recordings", - "purge" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Unauthorized" + "status": "OK" }, { "_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", @@ -56162,9 +61748,14 @@ "language": "json" } }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56177,70 +61768,20 @@ ], "path": [ "recordings", - "purge" - ], - "query": [ - { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" - } - }, - "status": "Gateway Timeout" - } - ] - }, - { - "name": "Share a Recording", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "raw": "{{baseUrl}}/recordings/query" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "status": "Method Not Allowed" }, - "description": "Share or unshare a recording with other users by recording ID and email addresses.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "recordings", - ":recordingId", - "accessList" - ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] - } - }, - "response": [ { "_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": "raw", @@ -56250,9 +61791,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56265,27 +61811,20 @@ ], "path": [ "recordings", - ":recordingId", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Conflict" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 401, "cookie": [], "header": [], - "name": "Not Found", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "body": { "mode": "raw", @@ -56295,9 +61834,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56310,19 +61854,12 @@ ], "path": [ "recordings", - ":recordingId", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -56340,9 +61877,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56355,16 +61897,9 @@ ], "path": [ "recordings", - ":recordingId", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, "status": "Gateway Timeout" @@ -56372,10 +61907,10 @@ { "_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", @@ -56385,9 +61920,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56400,19 +61940,12 @@ ], "path": [ "recordings", - ":recordingId", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -56430,9 +61963,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56445,16 +61983,9 @@ ], "path": [ "recordings", - ":recordingId", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, "status": "Precondition Required" @@ -56462,10 +61993,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 503, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -56475,9 +62006,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56490,27 +62026,20 @@ ], "path": [ "recordings", - ":recordingId", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Unauthorized" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 423, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "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", @@ -56520,9 +62049,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56535,27 +62069,20 @@ ], "path": [ "recordings", - ":recordingId", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Method Not Allowed" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 400, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "body": { "mode": "raw", @@ -56565,9 +62092,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56580,27 +62112,65 @@ ], "path": [ "recordings", - ":recordingId", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Gone" + "status": "Bad Request" + } + ] + }, + { + "name": "Query Recordings For an Admin or Compliance Officer", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, + "description": "Queries recordings for an admin or compliance officer with filters in the request body. You can specify a date range, a parent meeting ID, the maximum number of recordings to return, and additional filters such as siteUrl, integrationTag, topic, format, serviceType, and status.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. Please note that when `meetingId` is specified, parameters of `siteUrl`, `from`, and `to` will be ignored.\n\n* If `siteUrl` is specified, all the recordings on the specified site are listed; otherwise, all the recordings on the admin user's or compliance officer's preferred site are listed. All the available Webex sites and the admin user's or compliance officer's preferred site can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + "query" + ], + "raw": "{{baseUrl}}/admin/recordings/query" + } + }, + "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 423, "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": "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", @@ -56610,9 +62180,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56624,28 +62199,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - ":recordingId", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Unsupported Media Type" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { "body": { "mode": "raw", @@ -56655,9 +62224,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56669,28 +62243,36 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - ":recordingId", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Bad Gateway" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 400, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"SupportCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"status\": \"available\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"EventCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"status\": \"purged\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "code": 200, "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;charset=UTF-8" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -56700,12 +62282,21 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], "method": "POST", @@ -56714,28 +62305,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - ":recordingId", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Bad Request" + "status": "OK" }, { "_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": { "body": { "mode": "raw", @@ -56745,9 +62330,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56759,28 +62349,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - ":recordingId", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "No Content" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 415, "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": "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", @@ -56790,9 +62374,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56804,28 +62393,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - ":recordingId", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 405, "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": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -56835,9 +62418,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56849,28 +62437,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - ":recordingId", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Too Many Requests" + "status": "Method Not Allowed" }, { "_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": { "body": { "mode": "raw", @@ -56880,9 +62462,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56894,28 +62481,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - ":recordingId", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_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": { "body": { "mode": "raw", @@ -56925,9 +62506,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -56939,111 +62525,33 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - ":recordingId", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Internal Server Error" - } - ] - }, - { - "name": "List Group Recordings", - "request": { - "description": "List group recordings for a service app which has group recording access. You can specify a date range, the maximum number of recordings to return, and `personId` or `hostEmail` of whom the recordings will be retrieved.\n\n* The list returned is sorted in descending order by the date and time that the recordings were created.\n\n* Only recordings which are in the `available` status and not shared by others can be listed. Those in the `deleted` or `purged` status or shared by others can't be listed.\n\n* Long result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the API lists group recordings on the specified site; otherwise, the API lists group recordings on all the sites managed by the service app. All the sites managed by a service app can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* One of the `personId` parameter and `hostEmail` header must be specified so that only recordings of meetings hosted by the person of `personId` or `hostEmail` will be returned.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.\n\n* `hostEmail`: Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } - ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" - } - }, - "response": [ + "status": "Bad Gateway" + }, { "_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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -57051,80 +62559,43 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } + "admin", + "recordings", + "query" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Service Unavailable" + "status": "Precondition Required" }, { "_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", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -57132,80 +62603,43 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } + "admin", + "recordings", + "query" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Bad Gateway" + "status": "Service Unavailable" }, { "_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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -57213,80 +62647,43 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + "query" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Too Many Requests" }, { "_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", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -57294,80 +62691,43 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } + "admin", + "recordings", + "query" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Conflict" + "status": "Gateway Timeout" }, { "_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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -57375,80 +62735,43 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } + "admin", + "recordings", + "query" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Bad Request" + "status": "Unauthorized" }, { "_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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -57456,80 +62779,43 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } + "admin", + "recordings", + "query" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Unsupported Media Type" + "status": "Forbidden" }, { "_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", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -57537,80 +62823,43 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } + "admin", + "recordings", + "query" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Too Many Requests" + "status": "Gone" }, { "_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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -57618,594 +62867,325 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + "query" + ], + "raw": "{{baseUrl}}/admin/recordings/query" + } + }, + "status": "Conflict" + } + ] + } + ], + "name": "Recordings" + }, + { + "item": [ + { + "name": "List Report Templates", + "request": { + "description": "List all the available report templates that can be generated.\n\nCSV (comma separated value) reports for Webex services are only supported for organizations based in the North American region. Organizations based in other regions will return blank CSV files for any Webex reports.\n\n#### Validation Fields\n\nEach template includes validation rules that specify which fields are required when generating a report using the [Reports API](/docs/api/v1/reports). The possible validation field values are:\n\n- **templateId**: The unique identifier of the report template to use. This is always required when creating a report.\n- **siteList**: A comma-separated list of Webex sites (e.g., \"cisco.webex.com\"). Required for site-based templates, typically for Webex Meetings reports.\n- **subIds**: Subscription IDs for the report. Required for certain enterprise agreement templates, particularly for Webex Onboarding service reports.\n- **startDate**: The start date for the report data range in YYYY-MM-DD format. Required for date-range based templates.\n- **endDate**: The end date for the report data range in YYYY-MM-DD format. Required for date-range based templates.\n\nWhen creating a report, ensure you provide all fields marked as \"required\": \"yes\" in the template's validation rules.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "report", + "templates" + ], + "raw": "{{baseUrl}}/report/templates" + } + }, + "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": { + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" + "report", + "templates" ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } + "raw": "{{baseUrl}}/report/templates" + } + }, + "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": [ + "report", + "templates" + ], + "raw": "{{baseUrl}}/report/templates" + } + }, + "status": "Gone" + }, + { + "_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": [ + "report", + "templates" + ], + "raw": "{{baseUrl}}/report/templates" + } + }, + "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": [ + "report", + "templates" + ], + "raw": "{{baseUrl}}/report/templates" + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "report", + "templates" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" + "raw": "{{baseUrl}}/report/templates" } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } + "report", + "templates" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" + "raw": "{{baseUrl}}/report/templates" } }, - "status": "Gone" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 502, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } + "report", + "templates" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" + "raw": "{{baseUrl}}/report/templates" } }, - "status": "Precondition Required" + "status": "Bad Gateway" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } + "report", + "templates" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" + "raw": "{{baseUrl}}/report/templates" } }, - "status": "Gateway Timeout" + "status": "Forbidden" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } + "report", + "templates" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" + "raw": "{{baseUrl}}/report/templates" } }, - "status": "Not Found" + "status": "Service Unavailable" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } + "report", + "templates" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" + "raw": "{{baseUrl}}/report/templates" } }, - "status": "Method Not Allowed" + "status": "Too Many Requests" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } + "report", + "templates" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" + "raw": "{{baseUrl}}/report/templates" } }, - "status": "Unauthorized" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"MeetingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"deleted\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"SupportCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"purged\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "body": "[\n {\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"maxDays\": \"\",\n \"identifier\": \"\",\n \"validations\": {\n \"validations\": [\n {\n \"field\": \"\",\n \"required\": \"\"\n },\n {\n \"field\": \"\",\n \"required\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"maxDays\": \"\",\n \"identifier\": \"\",\n \"validations\": {\n \"validations\": [\n {\n \"field\": \"\",\n \"required\": \"\"\n },\n {\n \"field\": \"\",\n \"required\": \"\"\n }\n ]\n }\n }\n]", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json;charset=UTF-8" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" + "value": "application/json" } ], "name": "OK", "originalRequest": { "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - }, { "key": "Accept", - "value": "application/json;charset=UTF-8" + "value": "application/json" } ], "method": "GET", @@ -58214,162 +63194,121 @@ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } + "report", + "templates" + ], + "raw": "{{baseUrl}}/report/templates" + } + }, + "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": [ + "report", + "templates" + ], + "raw": "{{baseUrl}}/report/templates" + } + }, + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "report", + "templates" + ], + "raw": "{{baseUrl}}/report/templates" + } + }, + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "report", + "templates" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" + "raw": "{{baseUrl}}/report/templates" } }, - "status": "OK" + "status": "Gateway Timeout" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - } + "report", + "templates" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=EventCenter" + "raw": "{{baseUrl}}/report/templates" } }, - "status": "Forbidden" + "status": "Method Not Allowed" } ] - }, + } + ], + "name": "Report Templates" + }, + { + "item": [ { - "name": "Get Group Recording Details", + "name": "List Reports", "request": { - "description": "Retrieves details for a group recording for a service app which has group recording access.\n\n* Only recordings which are in the `available` status and not shared by others can be listed. Those in the `deleted` or `purged` status or shared by others can't be listed.\n\n* One of the `personId` parameter and `hostEmail` header must be specified so that only recordings of meetings hosted by the person of `personId` or `hostEmail` will be returned.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*\n\n* `hostEmail`: Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "description": "Lists all reports. Use query parameters to filter the response. The parameters are optional. However, `from` and `to` parameters should be provided together.\n\n**Notes**:\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.\n\nReports are usually provided in zip format. A Content-header `application/zip` or `application/octet-stream` does indicate the zip format. There is usually no .zip file extension.", "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - }, { "key": "Accept", - "value": "application/json;charset=UTF-8" + "value": "application/json" } ], "method": "GET", @@ -58378,291 +63317,301 @@ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, "response": [ { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, - "status": "Unauthorized" + "status": "Unsupported Media Type" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, - "status": "Forbidden" + "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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 429, "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": "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 404, "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": "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, - "status": "Internal Server Error" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 504, + "_postman_previewlanguage": "json", + "body": "{\n \"Report Attributes\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"created\": \"\",\n \"createdBy\": \"\",\n \"scheduledFrom\": \"\",\n \"status\": \"\",\n \"downloadURL\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"created\": \"\",\n \"createdBy\": \"\",\n \"scheduledFrom\": \"\",\n \"status\": \"\",\n \"downloadURL\": \"\"\n }\n ]\n}", + "code": 200, "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": "OK", "originalRequest": { "header": [ { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Accept", + "value": "application/json" } ], "method": "GET", @@ -58671,429 +63620,431 @@ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", + "value": "" + }, + { + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, - "status": "Gateway Timeout" + "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"MeetingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"available\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"temporaryDirectDownloadLinks\": {\n \"recordingDownloadLink\": \"\",\n \"audioDownloadLink\": \"\",\n \"transcriptDownloadLink\": \"\",\n \"expiration\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 503, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json;charset=UTF-8" - } - ], - "name": "OK", + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, - "status": "OK" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 409, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, - "status": "Precondition Required" + "status": "Conflict" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, - "status": "Unsupported Media Type" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 428, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, - "status": "Gone" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 504, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method 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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, - "status": "Method Not Allowed" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 410, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, - "status": "Bad Gateway" + "status": "Gone" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, - "status": "Service Unavailable" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 500, "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": "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -59103,43 +64054,43 @@ "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, "status": "Locked (WebDAV) (RFC 4918)" @@ -59147,56 +64098,56 @@ { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings", - ":recordingId" + "reports" ], "query": [ { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", + "description": "List reports by ID.", + "key": "reportId", "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ + }, { - "description": "A unique identifier for the recording.", - "key": "recordingId", + "description": "List reports which use this service.", + "key": "service", + "value": "" + }, + { + "description": "List reports with this report template ID.", + "key": "templateId", + "value": "" + }, + { + "description": "List reports that were created on or after this date.", + "key": "from", + "value": "" + }, + { + "description": "List reports that were created before this date.", + "key": "to", "value": "" } - ] + ], + "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" } }, - "status": "Bad Request" + "status": "Forbidden" } ] }, { - "name": "Share a Recording Link", + "name": "Create a Report", "request": { "body": { "mode": "raw", @@ -59206,13 +64157,17 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" }, - "description": "Share or unshare a recording with other users by recording link and email addresses.", + "description": "Create a new report. For each `templateId`, there are a set of validation rules that need to be followed. For example, for templates belonging to Webex, the user needs to provide `siteUrl`. These validation rules can be retrieved via the [Report Templates API](/docs/api/v1/report-templates).\n\nThe 'templateId' parameter is a number. However, it is a limitation of developer.webex.com platform that it is passed as a string when you try to test the API from here.\n\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.", "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -59221,58 +64176,19 @@ "{{baseUrl}}" ], "path": [ - "recordings", - "accessList" + "reports" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/reports" } }, "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 \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "recordings", - "accessList" - ], - "raw": "{{baseUrl}}/recordings/accessList" - } - }, - "status": "Conflict" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 204, + "code": 503, "cookie": [], "header": [], - "name": "No Content", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -59282,7 +64198,7 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -59296,21 +64212,20 @@ "{{baseUrl}}" ], "path": [ - "recordings", - "accessList" + "reports" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/reports" } }, - "status": "No Content" + "status": "Service Unavailable" }, { "_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": { "body": { "mode": "raw", @@ -59320,7 +64235,7 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -59334,13 +64249,12 @@ "{{baseUrl}}" ], "path": [ - "recordings", - "accessList" + "reports" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/reports" } }, - "status": "Gateway Timeout" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -59358,7 +64272,7 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -59372,21 +64286,25 @@ "{{baseUrl}}" ], "path": [ - "recordings", - "accessList" + "reports" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/reports" } }, "status": "Bad Gateway" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 405, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\"\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": { "body": { "mode": "raw", @@ -59396,49 +64314,15 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "recordings", - "accessList" - ], - "raw": "{{baseUrl}}/recordings/accessList" - } - }, - "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, - "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], @@ -59448,13 +64332,12 @@ "{{baseUrl}}" ], "path": [ - "recordings", - "accessList" + "reports" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/reports" } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "text", @@ -59462,7 +64345,7 @@ "code": 404, "cookie": [], "header": [], - "name": "Not Found", + "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", @@ -59472,7 +64355,7 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -59486,10 +64369,9 @@ "{{baseUrl}}" ], "path": [ - "recordings", - "accessList" + "reports" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/reports" } }, "status": "Not Found" @@ -59497,10 +64379,10 @@ { "_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", @@ -59510,7 +64392,7 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -59524,21 +64406,20 @@ "{{baseUrl}}" ], "path": [ - "recordings", - "accessList" + "reports" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/reports" } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_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", @@ -59548,7 +64429,7 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -59562,21 +64443,20 @@ "{{baseUrl}}" ], "path": [ - "recordings", - "accessList" + "reports" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/reports" } }, - "status": "Service Unavailable" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", @@ -59586,7 +64466,7 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -59600,21 +64480,20 @@ "{{baseUrl}}" ], "path": [ - "recordings", - "accessList" + "reports" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/reports" } }, - "status": "Unsupported Media Type" + "status": "Method Not Allowed" }, { "_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": { "body": { "mode": "raw", @@ -59624,7 +64503,7 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -59638,21 +64517,20 @@ "{{baseUrl}}" ], "path": [ - "recordings", - "accessList" + "reports" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/reports" } }, - "status": "Unauthorized" + "status": "Precondition Required" }, { "_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", @@ -59662,7 +64540,7 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -59676,21 +64554,20 @@ "{{baseUrl}}" ], "path": [ - "recordings", - "accessList" + "reports" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/reports" } }, - "status": "Precondition Required" + "status": "Too Many Requests" }, { "_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": { "body": { "mode": "raw", @@ -59700,7 +64577,7 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -59714,13 +64591,12 @@ "{{baseUrl}}" ], "path": [ - "recordings", - "accessList" + "reports" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/reports" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -59738,7 +64614,7 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -59752,10 +64628,9 @@ "{{baseUrl}}" ], "path": [ - "recordings", - "accessList" + "reports" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/reports" } }, "status": "Gone" @@ -59763,10 +64638,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 400, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "body": { "mode": "raw", @@ -59776,7 +64651,7 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -59790,21 +64665,20 @@ "{{baseUrl}}" ], "path": [ - "recordings", - "accessList" + "reports" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/reports" } }, - "status": "Forbidden" + "status": "Bad Request" }, { "_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": { "body": { "mode": "raw", @@ -59814,7 +64688,7 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -59828,281 +64702,126 @@ "{{baseUrl}}" ], "path": [ - "recordings", - "accessList" - ], - "raw": "{{baseUrl}}/recordings/accessList" - } - }, - "status": "Bad Request" - } - ] - } - ], - "name": "Recordings" - }, - { - "item": [ - { - "name": "List Report Templates", - "request": { - "description": "List all the available report templates that can be generated.\n\nCSV (comma separated value) reports for Webex services are only supported for organizations based in the North American region. Organizations based in other regions will return blank CSV files for any Webex reports.\n\n#### Validation Fields\n\nEach template includes validation rules that specify which fields are required when generating a report using the [Reports API](/docs/api/v1/reports). The possible validation field values are:\n\n- **templateId**: The unique identifier of the report template to use. This is always required when creating a report.\n- **siteList**: A comma-separated list of Webex sites (e.g., \"cisco.webex.com\"). Required for site-based templates, typically for Webex Meetings reports.\n- **subIds**: Subscription IDs for the report. Required for certain enterprise agreement templates, particularly for Webex Onboarding service reports.\n- **startDate**: The start date for the report data range in YYYY-MM-DD format. Required for date-range based templates.\n- **endDate**: The end date for the report data range in YYYY-MM-DD format. Required for date-range based templates.\n\nWhen creating a report, ensure you provide all fields marked as \"required\": \"yes\" in the template's validation rules.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "report", - "templates" - ], - "raw": "{{baseUrl}}/report/templates" - } - }, - "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": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "report", - "templates" - ], - "raw": "{{baseUrl}}/report/templates" - } - }, - "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": [ - "report", - "templates" - ], - "raw": "{{baseUrl}}/report/templates" - } - }, - "status": "Gone" - }, - { - "_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": [ - "report", - "templates" - ], - "raw": "{{baseUrl}}/report/templates" - } - }, - "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": [ - "report", - "templates" - ], - "raw": "{{baseUrl}}/report/templates" - } - }, - "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": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "report", - "templates" - ], - "raw": "{{baseUrl}}/report/templates" - } - }, - "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": [ - "report", - "templates" - ], - "raw": "{{baseUrl}}/report/templates" - } - }, - "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": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "report", - "templates" - ], - "raw": "{{baseUrl}}/report/templates" - } - }, - "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": [ - "report", - "templates" + "reports" ], - "raw": "{{baseUrl}}/report/templates" + "raw": "{{baseUrl}}/reports" } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "report", - "templates" + "reports" ], - "raw": "{{baseUrl}}/report/templates" + "raw": "{{baseUrl}}/reports" } }, - "status": "Service Unavailable" + "status": "Unsupported Media Type" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "report", - "templates" + "reports" ], - "raw": "{{baseUrl}}/report/templates" + "raw": "{{baseUrl}}/reports" } }, - "status": "Too Many Requests" - }, + "status": "Conflict" + } + ] + }, + { + "name": "Get Report Details", + "request": { + "description": "Shows details for a report, by report ID.\n\nSpecify the report ID in the `reportId` parameter in the URI.\n\n**Notes**:\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.\n\nReports are usually provided in zip format. A Content-header `application/zip` or `application/octet-stream` does indicate the zip format. There is usually no .zip file extension.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "reports", + ":reportId" + ], + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId", + "value": "" + } + ] + } + }, + "response": [ { "_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": { "header": [], "method": "GET", @@ -60111,54 +64830,56 @@ "{{baseUrl}}" ], "path": [ - "report", - "templates" + "reports", + ":reportId" ], - "raw": "{{baseUrl}}/report/templates" + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Unsupported Media Type" + "status": "Conflict" }, { - "_postman_previewlanguage": "json", - "body": "[\n {\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"maxDays\": \"\",\n \"identifier\": \"\",\n \"validations\": {\n \"validations\": [\n {\n \"field\": \"\",\n \"required\": \"\"\n },\n {\n \"field\": \"\",\n \"required\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"maxDays\": \"\",\n \"identifier\": \"\",\n \"validations\": {\n \"validations\": [\n {\n \"field\": \"\",\n \"required\": \"\"\n },\n {\n \"field\": \"\",\n \"required\": \"\"\n }\n ]\n }\n }\n]", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 404, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "report", - "templates" + "reports", + ":reportId" ], - "raw": "{{baseUrl}}/report/templates" + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "OK" + "status": "Not Found" }, { "_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", @@ -60167,21 +64888,27 @@ "{{baseUrl}}" ], "path": [ - "report", - "templates" + "reports", + ":reportId" ], - "raw": "{{baseUrl}}/report/templates" + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Unauthorized" + "status": "Gone" }, { "_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", @@ -60190,21 +64917,27 @@ "{{baseUrl}}" ], "path": [ - "report", - "templates" + "reports", + ":reportId" ], - "raw": "{{baseUrl}}/report/templates" + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 429, "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": "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", @@ -60213,21 +64946,27 @@ "{{baseUrl}}" ], "path": [ - "report", - "templates" + "reports", + ":reportId" ], - "raw": "{{baseUrl}}/report/templates" + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Gateway Timeout" + "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", @@ -60236,77 +64975,27 @@ "{{baseUrl}}" ], "path": [ - "report", - "templates" + "reports", + ":reportId" ], - "raw": "{{baseUrl}}/report/templates" + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Method Not Allowed" - } - ] - } - ], - "name": "Report Templates" - }, - { - "item": [ - { - "name": "List Reports", - "request": { - "description": "Lists all reports. Use query parameters to filter the response. The parameters are optional. However, `from` and `to` parameters should be provided together.\n\n**Notes**:\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.\n\nReports are usually provided in zip format. A Content-header `application/zip` or `application/octet-stream` does indicate the zip format. There is usually no .zip file extension.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "reports" - ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, - { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" - } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" - } - }, - "response": [ + "status": "Service Unavailable" + }, { "_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": "GET", @@ -60315,47 +65004,27 @@ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" + "description": "The unique identifier for the report.", + "key": "reportId" } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" + ] } }, - "status": "Unsupported Media Type" + "status": "Forbidden" }, { "_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": { "header": [], "method": "GET", @@ -60364,47 +65033,27 @@ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" + "description": "The unique identifier for the report.", + "key": "reportId" } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" + ] } }, - "status": "Bad Gateway" + "status": "Internal Server Error" }, { "_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", @@ -60413,47 +65062,27 @@ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" + "description": "The unique identifier for the report.", + "key": "reportId" } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" + ] } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 405, "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": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -60462,47 +65091,27 @@ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" + "description": "The unique identifier for the report.", + "key": "reportId" } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" + ] } }, - "status": "Too Many Requests" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 504, "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": "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", @@ -60511,43 +65120,23 @@ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" + "description": "The unique identifier for the report.", + "key": "reportId" } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" + ] } }, - "status": "Not Found" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "json", - "body": "{\n \"Report Attributes\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"created\": \"\",\n \"createdBy\": \"\",\n \"scheduledFrom\": \"\",\n \"status\": \"\",\n \"downloadURL\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"created\": \"\",\n \"createdBy\": \"\",\n \"scheduledFrom\": \"\",\n \"status\": \"\",\n \"downloadURL\": \"\"\n }\n ]\n}", + "body": "{\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"timeZone\": \"\",\n \"created\": \"\",\n \"createdBy\": \"\",\n \"scheduledFrom\": \"\",\n \"status\": \"\",\n \"downloadURL\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -60570,36 +65159,16 @@ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" + "description": "The unique identifier for the report.", + "key": "reportId" } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" + ] } }, "status": "OK" @@ -60607,10 +65176,10 @@ { "_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", @@ -60619,47 +65188,27 @@ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" + "description": "The unique identifier for the report.", + "key": "reportId" } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" + ] } }, - "status": "Service Unavailable" + "status": "Precondition Required" }, { "_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": { "header": [], "method": "GET", @@ -60668,47 +65217,27 @@ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" + "description": "The unique identifier for the report.", + "key": "reportId" } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" + ] } }, - "status": "Conflict" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 415, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -60717,47 +65246,27 @@ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" + "description": "The unique identifier for the report.", + "key": "reportId" } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" + ] } }, - "status": "Bad Request" + "status": "Unsupported Media Type" }, { "_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", @@ -60766,235 +65275,162 @@ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" + "description": "The unique identifier for the report.", + "key": "reportId" } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" + ] } }, - "status": "Precondition Required" - }, + "status": "Locked (WebDAV) (RFC 4918)" + } + ] + }, + { + "name": "Delete a Report", + "request": { + "description": "Remove a report from the system.\n\nSpecify the report ID in the `reportId` parameter in the URI\n\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.", + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "reports", + ":reportId" + ], + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId", + "value": "" + } + ] + } + }, + "response": [ { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" + "description": "The unique identifier for the report.", + "key": "reportId" } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" + ] } }, - "status": "Gateway Timeout" + "status": "Bad Request" }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" + "description": "The unique identifier for the report.", + "key": "reportId" } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" + ] } }, - "status": "Gone" + "status": "Service Unavailable" }, { "_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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" + "description": "The unique identifier for the report.", + "key": "reportId" } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" + ] } }, - "status": "Method Not Allowed" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 404, "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": "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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" + "description": "The unique identifier for the report.", + "key": "reportId" } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" + ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "text", @@ -61005,46 +65441,55 @@ "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": [ - "reports" + "reports", + ":reportId" ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" + "description": "The unique identifier for the report.", + "key": "reportId" } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" + ] } }, "status": "Locked (WebDAV) (RFC 4918)" }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "reports", + ":reportId" + ], + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] + } + }, + "status": "No Content" + }, { "_postman_previewlanguage": "text", "body": null, @@ -61054,157 +65499,112 @@ "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "query": [ - { - "description": "List reports by ID.", - "key": "reportId", - "value": "" - }, - { - "description": "List reports which use this service.", - "key": "service", - "value": "" - }, - { - "description": "List reports with this report template ID.", - "key": "templateId", - "value": "" - }, - { - "description": "List reports that were created on or after this date.", - "key": "from", - "value": "" - }, + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ { - "description": "List reports that were created before this date.", - "key": "to", - "value": "" + "description": "The unique identifier for the report.", + "key": "reportId" } - ], - "raw": "{{baseUrl}}/reports?reportId=&service=&templateId=&from=&to=" + ] } }, "status": "Forbidden" - } - ] - }, - { - "name": "Create a Report", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" }, - "description": "Create a new report. For each `templateId`, there are a set of validation rules that need to be followed. For example, for templates belonging to Webex, the user needs to provide `siteUrl`. These validation rules can be retrieved via the [Report Templates API](/docs/api/v1/report-templates).\n\nThe 'templateId' parameter is a number. However, it is a limitation of developer.webex.com platform that it is passed as a string when you try to test the API from here.\n\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "reports" - ], - "raw": "{{baseUrl}}/reports" - } - }, - "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "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": [ + "reports", + ":reportId" + ], + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "raw": "{{baseUrl}}/reports" + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Service Unavailable" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 409, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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 \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "raw": "{{baseUrl}}/reports" + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Forbidden" + "status": "Conflict" }, { "_postman_previewlanguage": "text", @@ -61214,117 +65614,84 @@ "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 \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "raw": "{{baseUrl}}/reports" + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, "status": "Bad Gateway" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 504, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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 \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "raw": "{{baseUrl}}/reports" + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "OK" + "status": "Gateway Timeout" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "raw": "{{baseUrl}}/reports" + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -61334,31 +65701,23 @@ "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 \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "raw": "{{baseUrl}}/reports" + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, "status": "Internal Server Error" @@ -61366,412 +65725,644 @@ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "reports", + ":reportId" ], - "raw": "{{baseUrl}}/reports" + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gone" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "reports", + ":reportId" + ], + "raw": "{{baseUrl}}/reports/:reportId", + "variable": [ + { + "description": "The unique identifier for the report.", + "key": "reportId" } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" + ] + } + }, + "status": "Precondition Required" + } + ] + } + ], + "name": "Reports" + }, + { + "item": [ + { + "name": "List Resource Group Memberships", + "request": { + "description": "Lists all resource group memberships for an organization.\n\nUse query parameters to filter the response.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "resourceGroup", + "memberships" + ], + "query": [ + { + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" + } + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + } + }, + "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": { + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "resourceGroup", + "memberships" ], - "raw": "{{baseUrl}}/reports" + "query": [ + { + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" + } + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" } }, - "status": "Method Not Allowed" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 409, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "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 \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "resourceGroup", + "memberships" ], - "raw": "{{baseUrl}}/reports" + "query": [ + { + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" + } + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" } }, - "status": "Precondition Required" + "status": "Conflict" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "resourceGroup", + "memberships" + ], + "query": [ + { + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n },\n {\n \"id\": \"\",\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"activated\"\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": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "resourceGroup", + "memberships" ], - "raw": "{{baseUrl}}/reports" + "query": [ + { + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" + } + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" } }, - "status": "Too Many Requests" + "status": "OK" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "resourceGroup", + "memberships" ], - "raw": "{{baseUrl}}/reports" + "query": [ + { + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" + } + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" } }, - "status": "Gateway Timeout" + "status": "Precondition Required" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "resourceGroup", + "memberships" ], - "raw": "{{baseUrl}}/reports" + "query": [ + { + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" + } + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" } }, - "status": "Gone" + "status": "Bad Gateway" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "resourceGroup", + "memberships" ], - "raw": "{{baseUrl}}/reports" + "query": [ + { + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" + } + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 405, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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 \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "resourceGroup", + "memberships" ], - "raw": "{{baseUrl}}/reports" + "query": [ + { + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" + } + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" } }, - "status": "Unauthorized" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 423, "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": "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 \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "resourceGroup", + "memberships" ], - "raw": "{{baseUrl}}/reports" + "query": [ + { + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" + } + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" } }, - "status": "Unsupported Media Type" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"templateId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports" + "resourceGroup", + "memberships" ], - "raw": "{{baseUrl}}/reports" + "query": [ + { + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" + } + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" } }, - "status": "Conflict" - } - ] - }, - { - "name": "Get Report Details", - "request": { - "description": "Shows details for a report, by report ID.\n\nSpecify the report ID in the `reportId` parameter in the URI.\n\n**Notes**:\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.\n\nReports are usually provided in zip format. A Content-header `application/zip` or `application/octet-stream` does indicate the zip format. There is usually no .zip file extension.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "reports", - ":reportId" - ], - "raw": "{{baseUrl}}/reports/:reportId", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId", - "value": "" - } - ] - } - }, - "response": [ + "status": "Unsupported Media Type" + }, { "_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": { "header": [], "method": "GET", @@ -61780,27 +66371,48 @@ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships" ], - "raw": "{{baseUrl}}/reports/:reportId", - "variable": [ + "query": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" } - ] + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" } }, - "status": "Conflict" + "status": "Service Unavailable" }, { "_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", @@ -61809,27 +66421,48 @@ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships" ], - "raw": "{{baseUrl}}/reports/:reportId", - "variable": [ + "query": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" } - ] + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_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": { "header": [], "method": "GET", @@ -61838,27 +66471,48 @@ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships" ], - "raw": "{{baseUrl}}/reports/:reportId", - "variable": [ + "query": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" } - ] + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" } }, - "status": "Gone" + "status": "Not Found" }, { "_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": { "header": [], "method": "GET", @@ -61867,19 +66521,40 @@ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships" ], - "raw": "{{baseUrl}}/reports/:reportId", - "variable": [ + "query": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" } - ] + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -61896,16 +66571,37 @@ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships" ], - "raw": "{{baseUrl}}/reports/:reportId", - "variable": [ + "query": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" } - ] + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" } }, "status": "Too Many Requests" @@ -61913,10 +66609,10 @@ { "_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": { "header": [], "method": "GET", @@ -61925,27 +66621,81 @@ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships" ], - "raw": "{{baseUrl}}/reports/:reportId", - "variable": [ + "query": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships for a person, by ID.", + "key": "personId", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "personOrgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" } - ] + ], + "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" } }, - "status": "Service Unavailable" - }, + "status": "Bad Request" + } + ] + }, + { + "name": "Get Resource Group Membership Details", + "request": { + "description": "Shows details for a resource group membership, by ID.\n\nSpecify the resource group membership ID in the `resourceGroupMembershipId` URI parameter.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" + ], + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", + "variable": [ + { + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId", + "value": "" + } + ] + } + }, + "response": [ { "_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", @@ -61954,27 +66704,28 @@ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Forbidden" + "status": "Precondition Required" }, { "_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", @@ -61983,27 +66734,28 @@ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 405, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -62012,27 +66764,28 @@ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Bad Request" + "status": "Method Not Allowed" }, { "_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", @@ -62041,27 +66794,28 @@ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Method Not Allowed" + "status": "Conflict" }, { "_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": { "header": [], "method": "GET", @@ -62070,66 +66824,58 @@ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Gateway Timeout" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"title\": \"\",\n \"service\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"siteList\": \"\",\n \"created\": \"\",\n \"createdBy\": \"\",\n \"scheduledFrom\": \"\",\n \"status\": \"\",\n \"downloadURL\": \"\"\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": [ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "OK" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { "header": [], "method": "GET", @@ -62138,27 +66884,28 @@ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Precondition Required" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 401, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], "method": "GET", @@ -62167,19 +66914,20 @@ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Bad Gateway" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -62196,14 +66944,15 @@ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } @@ -62213,10 +66962,10 @@ { "_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", @@ -62225,894 +66974,1052 @@ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" - } - ] - }, - { - "name": "Delete a Report", - "request": { - "description": "Remove a report from the system.\n\nSpecify the report ID in the `reportId` parameter in the URI\n\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.", - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "reports", - ":reportId" - ], - "raw": "{{baseUrl}}/reports/:reportId", - "variable": [ - { - "description": "The unique identifier for the report.", - "key": "reportId", - "value": "" - } - ] - } - }, - "response": [ + "status": "Service Unavailable" + }, { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Bad Request" + "status": "Bad Gateway" }, { "_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}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Service Unavailable" + "status": "Gone" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Unsupported Media Type" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 504, "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": "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}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Not Found" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 403, "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": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 204, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}", + "code": 200, "cookie": [], - "header": [], - "name": "No Content", - "originalRequest": { - "header": [], - "method": "DELETE", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "No Content" + "status": "OK" + } + ] + }, + { + "name": "Update a Resource Group Membership", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" }, + "description": "Updates a resource group membership, by ID.\n\nSpecify the resource group membership ID in the `resourceGroupMembershipId`\u00a0URI parameter.\n\nOnly the `resourceGroupId`\u00a0can be changed with this action. Resource group memberships with a `status`\u00a0of \"pending\" cannot be updated. For more information about resource group memberships, see the [Managing Hybrid Services](/docs/api/guides/managing-hybrid-services-licenses#webex-resource-groups) guide.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" + ], + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", + "variable": [ + { + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 400, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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 \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Forbidden" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 429, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\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": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Method Not Allowed" + "status": "Bad Gateway" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Conflict" + "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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Bad Gateway" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 410, "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": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Gateway Timeout" + "status": "Gone" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Unauthorized" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 503, "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": "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 \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Internal Server Error" + "status": "Service Unavailable" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Gone" + "status": "Forbidden" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "reports", - ":reportId" + "resourceGroup", + "memberships", + ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/reports/:reportId", + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", "variable": [ { - "description": "The unique identifier for the report.", - "key": "reportId" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } ] } }, - "status": "Precondition Required" - } - ] - } - ], - "name": "Reports" - }, - { - "item": [ - { - "name": "List Resource Group Memberships", - "request": { - "description": "Lists all resource group memberships for an organization.\n\nUse query parameters to filter the response.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "resourceGroup", - "memberships" - ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" - } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" - } - }, - "response": [ + "status": "Unauthorized" + }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "resourceGroup", - "memberships" + "memberships", + ":resourceGroupMembershipId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + ] } }, - "status": "Gateway Timeout" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 429, "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": "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 \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "resourceGroup", - "memberships" + "memberships", + ":resourceGroupMembershipId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + ] } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "resourceGroup", - "memberships" + "memberships", + ":resourceGroupMembershipId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + ] } }, - "status": "Gone" + "status": "Gateway Timeout" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n },\n {\n \"id\": \"\",\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"activated\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 405, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" - } - ], - "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 \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "resourceGroup", - "memberships" + "memberships", + ":resourceGroupMembershipId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + ] } }, - "status": "OK" + "status": "Method Not Allowed" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "resourceGroup", - "memberships" + "memberships", + ":resourceGroupMembershipId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + ] } }, - "status": "Precondition Required" + "status": "Unsupported Media Type" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "resourceGroup", - "memberships" + "memberships", + ":resourceGroupMembershipId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, + "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group membership.", + "key": "resourceGroupMembershipId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + ] } }, - "status": "Bad Gateway" - }, + "status": "Not Found" + } + ] + }, + { + "name": "List Resource Group Memberships V2", + "request": { + "description": "Lists all resource group memberships for an organization having filtering option based on entity type (User / Workspace).\n\nUse query parameters to filter the response.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "resourceGroup", + "memberships", + "v2" + ], + "query": [ + { + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships by ID.", + "key": "id", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "orgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" + } + ], + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + } + }, + "response": [ { "_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", @@ -63122,7 +68029,8 @@ ], "path": [ "resourceGroup", - "memberships" + "memberships", + "v2" ], "query": [ { @@ -63131,13 +68039,13 @@ "value": "" }, { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", + "description": "List resource group memberships by ID.", + "key": "id", "value": "" }, { "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", + "key": "orgId", "value": "" }, { @@ -63145,24 +68053,29 @@ "key": "status", "value": "activated" }, + { + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, { "description": "Limit the maximum number of resource group memberships in the response.", "key": "max", "value": "100" } ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" } }, - "status": "Forbidden" + "status": "Service Unavailable" }, { "_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": { "header": [], "method": "GET", @@ -63172,7 +68085,8 @@ ], "path": [ "resourceGroup", - "memberships" + "memberships", + "v2" ], "query": [ { @@ -63181,13 +68095,13 @@ "value": "" }, { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", + "description": "List resource group memberships by ID.", + "key": "id", "value": "" }, { "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", + "key": "orgId", "value": "" }, { @@ -63195,24 +68109,29 @@ "key": "status", "value": "activated" }, + { + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, { "description": "Limit the maximum number of resource group memberships in the response.", "key": "max", "value": "100" } ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" } }, - "status": "Method Not Allowed" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 404, "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": "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", @@ -63222,7 +68141,8 @@ ], "path": [ "resourceGroup", - "memberships" + "memberships", + "v2" ], "query": [ { @@ -63231,13 +68151,13 @@ "value": "" }, { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", + "description": "List resource group memberships by ID.", + "key": "id", "value": "" }, { "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", + "key": "orgId", "value": "" }, { @@ -63245,24 +68165,29 @@ "key": "status", "value": "activated" }, + { + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, { "description": "Limit the maximum number of resource group memberships in the response.", "key": "max", "value": "100" } ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 502, "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 Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -63272,7 +68197,8 @@ ], "path": [ "resourceGroup", - "memberships" + "memberships", + "v2" ], "query": [ { @@ -63281,13 +68207,13 @@ "value": "" }, { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", + "description": "List resource group memberships by ID.", + "key": "id", "value": "" }, { "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", + "key": "orgId", "value": "" }, { @@ -63295,24 +68221,29 @@ "key": "status", "value": "activated" }, + { + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, { "description": "Limit the maximum number of resource group memberships in the response.", "key": "max", "value": "100" } ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" } }, - "status": "Unsupported Media Type" + "status": "Bad Gateway" }, { "_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": { "header": [], "method": "GET", @@ -63322,7 +68253,8 @@ ], "path": [ "resourceGroup", - "memberships" + "memberships", + "v2" ], "query": [ { @@ -63331,13 +68263,13 @@ "value": "" }, { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", + "description": "List resource group memberships by ID.", + "key": "id", "value": "" }, { "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", + "key": "orgId", "value": "" }, { @@ -63345,16 +68277,21 @@ "key": "status", "value": "activated" }, + { + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, { "description": "Limit the maximum number of resource group memberships in the response.", "key": "max", "value": "100" } ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -63372,7 +68309,8 @@ ], "path": [ "resourceGroup", - "memberships" + "memberships", + "v2" ], "query": [ { @@ -63381,13 +68319,13 @@ "value": "" }, { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", + "description": "List resource group memberships by ID.", + "key": "id", "value": "" }, { "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", + "key": "orgId", "value": "" }, { @@ -63395,13 +68333,18 @@ "key": "status", "value": "activated" }, + { + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, { "description": "Limit the maximum number of resource group memberships in the response.", "key": "max", "value": "100" } ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" } }, "status": "Unauthorized" @@ -63409,10 +68352,10 @@ { "_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": { "header": [], "method": "GET", @@ -63422,7 +68365,8 @@ ], "path": [ "resourceGroup", - "memberships" + "memberships", + "v2" ], "query": [ { @@ -63431,13 +68375,13 @@ "value": "" }, { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", + "description": "List resource group memberships by ID.", + "key": "id", "value": "" }, { "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", + "key": "orgId", "value": "" }, { @@ -63445,24 +68389,29 @@ "key": "status", "value": "activated" }, + { + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, { "description": "Limit the maximum number of resource group memberships in the response.", "key": "max", "value": "100" } ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" } }, - "status": "Not Found" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 410, "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": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -63472,7 +68421,8 @@ ], "path": [ "resourceGroup", - "memberships" + "memberships", + "v2" ], "query": [ { @@ -63481,13 +68431,13 @@ "value": "" }, { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", + "description": "List resource group memberships by ID.", + "key": "id", "value": "" }, { "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", + "key": "orgId", "value": "" }, { @@ -63495,24 +68445,29 @@ "key": "status", "value": "activated" }, + { + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, { "description": "Limit the maximum number of resource group memberships in the response.", "key": "max", "value": "100" } ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" } }, - "status": "Internal Server Error" + "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": "GET", @@ -63522,7 +68477,8 @@ ], "path": [ "resourceGroup", - "memberships" + "memberships", + "v2" ], "query": [ { @@ -63531,13 +68487,13 @@ "value": "" }, { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", + "description": "List resource group memberships by ID.", + "key": "id", "value": "" }, { "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", + "key": "orgId", "value": "" }, { @@ -63545,24 +68501,29 @@ "key": "status", "value": "activated" }, + { + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, { "description": "Limit the maximum number of resource group memberships in the response.", "key": "max", "value": "100" } ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" } }, - "status": "Too Many Requests" + "status": "Unsupported Media Type" }, { "_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", @@ -63572,7 +68533,8 @@ ], "path": [ "resourceGroup", - "memberships" + "memberships", + "v2" ], "query": [ { @@ -63581,13 +68543,13 @@ "value": "" }, { - "description": "List resource group memberships for a person, by ID.", - "key": "personId", + "description": "List resource group memberships by ID.", + "key": "id", "value": "" }, { "description": "List resource group memberships for an organization, by ID.", - "key": "personOrgId", + "key": "orgId", "value": "" }, { @@ -63595,59 +68557,50 @@ "key": "status", "value": "activated" }, + { + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, { "description": "Limit the maximum number of resource group memberships in the response.", "key": "max", "value": "100" } ], - "raw": "{{baseUrl}}/resourceGroup/memberships?licenseId=&personId=&personOrgId=&status=activated&max=100" + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" } }, - "status": "Bad Request" - } - ] - }, - { - "name": "Get Resource Group Membership Details", - "request": { - "description": "Shows details for a resource group membership, by ID.\n\nSpecify the resource group membership ID in the `resourceGroupMembershipId` URI parameter.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n },\n {\n \"id\": \"\",\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"activated\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId", + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", "value": "" } - ] - } - }, - "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.", + ], + "name": "OK", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ @@ -63656,206 +68609,52 @@ "path": [ "resourceGroup", "memberships", - ":resourceGroupMembershipId" + "v2" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" - } - ] - } - }, - "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": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" - } - ] - } - }, - "status": "Bad Request" - }, - { - "_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": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "description": "List resource group memberships by ID.", + "key": "id", + "value": "" + }, { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" - } - ] - } - }, - "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": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "description": "List resource group memberships for an organization, by ID.", + "key": "orgId", + "value": "" + }, { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" - } - ] - } - }, - "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).", - "originalRequest": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" - } - ] - } - }, - "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": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" } - ] - } - }, - "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": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ - { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" - } - ] + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" } }, - "status": "Not Found" + "status": "OK" }, { "_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": "GET", @@ -63866,116 +68665,52 @@ "path": [ "resourceGroup", "memberships", - ":resourceGroupMembershipId" + "v2" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" - } - ] - } - }, - "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": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" - } - ] - } - }, - "status": "Unsupported Media Type" - }, - { - "_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": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "description": "List resource group memberships by ID.", + "key": "id", + "value": "" + }, { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" - } - ] - } - }, - "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": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "description": "List resource group memberships for an organization, by ID.", + "key": "orgId", + "value": "" + }, { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" } - ] + ], + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" } }, - "status": "Bad Gateway" + "status": "Gateway Timeout" }, { "_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", @@ -63986,26 +68721,52 @@ "path": [ "resourceGroup", "memberships", - ":resourceGroupMembershipId" + "v2" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships by ID.", + "key": "id", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "orgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" } - ] + ], + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" } }, - "status": "Gone" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 400, "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": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], "method": "GET", @@ -64016,26 +68777,52 @@ "path": [ "resourceGroup", "memberships", - ":resourceGroupMembershipId" + "v2" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships by ID.", + "key": "id", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "orgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" } - ] + ], + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" } }, - "status": "Too Many Requests" + "status": "Bad Request" }, { "_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": { "header": [], "method": "GET", @@ -64046,26 +68833,52 @@ "path": [ "resourceGroup", "memberships", - ":resourceGroupMembershipId" + "v2" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, + { + "description": "List resource group memberships by ID.", + "key": "id", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "orgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" } - ] + ], + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" } }, - "status": "Gateway Timeout" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 423, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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", @@ -64076,744 +68889,399 @@ "path": [ "resourceGroup", "memberships", - ":resourceGroupMembershipId" + "v2" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" - } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\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": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "description": "List resource group memberships for a license, by ID.", + "key": "licenseId", + "value": "" + }, { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "List resource group memberships by ID.", + "key": "id", + "value": "" + }, + { + "description": "List resource group memberships for an organization, by ID.", + "key": "orgId", + "value": "" + }, + { + "description": "Limit resource group memberships to a specific status.", + "key": "status", + "value": "activated" + }, + { + "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", + "key": "type", + "value": "User" + }, + { + "description": "Limit the maximum number of resource group memberships in the response.", + "key": "max", + "value": "100" } - ] + ], + "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" } }, - "status": "OK" + "status": "Locked (WebDAV) (RFC 4918)" } ] - }, + } + ], + "name": "Resource Group Memberships" + }, + { + "item": [ { - "name": "Update a Resource Group Membership", + "name": "List Resource Groups", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, - "description": "Updates a resource group membership, by ID.\n\nSpecify the resource group membership ID in the `resourceGroupMembershipId`\u00a0URI parameter.\n\nOnly the `resourceGroupId`\u00a0can be changed with this action. Resource group memberships with a `status`\u00a0of \"pending\" cannot be updated. For more information about resource group memberships, see the [Managing Hybrid Services](/docs/api/guides/managing-hybrid-services-licenses#webex-resource-groups) guide.", + "description": "List resource groups.\n\nUse query parameters to filter the response.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" + "resourceGroups" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId", + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", "value": "" } - ] + ], + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 405, "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 \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ - { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" - } - ] - } - }, - "status": "Bad Request" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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 \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" + "resourceGroups" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" - } - ] - } - }, - "status": "OK" - }, - { - "_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" + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" } - }, - "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ - { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" - } - ] + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, - "status": "Bad Gateway" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 400, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "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 \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" + "resourceGroups" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" - } - ] - } - }, - "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" } - }, - "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ - { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" - } - ] + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], - "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "path": [ + "resourceGroups" + ], + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, - "status": "Gone" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" + "resourceGroups" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, - "status": "Conflict" + "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" + "resourceGroups" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, - "status": "Service Unavailable" + "status": "Not Found" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" + "resourceGroups" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, - "status": "Forbidden" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 429, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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 \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" + "resourceGroups" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" + "resourceGroups" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 503, "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": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" + "resourceGroups" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, - "status": "Too Many Requests" + "status": "Service Unavailable" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" + "resourceGroups" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, - "status": "Gateway Timeout" + "status": "Precondition Required" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" + "resourceGroups" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, - "status": "Method Not Allowed" + "status": "Conflict" }, { "_postman_previewlanguage": "text", @@ -64823,201 +69291,94 @@ "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 \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" + "resourceGroups" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, "status": "Unsupported Media Type" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 404, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"orgId\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"orgId\": \"\"\n }\n ]\n}", + "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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n}" - }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - ":resourceGroupMembershipId" + "resourceGroups" ], - "raw": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId", - "variable": [ + "query": [ { - "description": "The unique identifier for the resource group membership.", - "key": "resourceGroupMembershipId" + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, - "status": "Not Found" - } - ] - }, - { - "name": "List Resource Group Memberships V2", - "request": { - "description": "Lists all resource group memberships for an organization having filtering option based on entity type (User / Workspace).\n\nUse query parameters to filter the response.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "resourceGroup", - "memberships", - "v2" - ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, - { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" - } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" - } - }, - "response": [ + "status": "OK" + }, { "_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", "url": { "host": [ "{{baseUrl}}" - ], - "path": [ - "resourceGroup", - "memberships", - "v2" - ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, + ], + "path": [ + "resourceGroups" + ], + "query": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" } ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, - "status": "Service Unavailable" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -65034,43 +69395,16 @@ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - "v2" + "resourceGroups" ], "query": [ { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", "key": "orgId", "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, - { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" } ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, "status": "Forbidden" @@ -65078,10 +69412,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 500, "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": "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", @@ -65090,54 +69424,59 @@ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - "v2" + "resourceGroups" ], "query": [ { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", + "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", "key": "orgId", "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, - { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" } ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + "raw": "{{baseUrl}}/resourceGroups?orgId=" } }, - "status": "Not Found" - }, + "status": "Internal Server Error" + } + ] + }, + { + "name": "Get Resource Group Details", + "request": { + "description": "Shows details for a resource group, by ID.\n\nSpecify the resource group ID in the `resourceGroupId` parameter in the URI.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "resourceGroups", + ":resourceGroupId" + ], + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ + { + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId", + "value": "" + } + ] + } + }, + "response": [ { "_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", @@ -65146,54 +69485,27 @@ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - "v2" + "resourceGroups", + ":resourceGroupId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + ] } }, - "status": "Bad Gateway" + "status": "Too Many Requests" }, { "_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": "GET", @@ -65202,54 +69514,27 @@ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - "v2" + "resourceGroups", + ":resourceGroupId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + ] } }, - "status": "Internal Server Error" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 503, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -65258,46 +69543,19 @@ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - "v2" + "resourceGroups", + ":resourceGroupId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + ] } }, - "status": "Unauthorized" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", @@ -65314,43 +69572,16 @@ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - "v2" + "resourceGroups", + ":resourceGroupId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + ] } }, "status": "Precondition Required" @@ -65358,10 +69589,10 @@ { "_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": { "header": [], "method": "GET", @@ -65370,54 +69601,27 @@ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - "v2" + "resourceGroups", + ":resourceGroupId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + ] } }, - "status": "Gone" + "status": "Method Not Allowed" }, { "_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": { "header": [], "method": "GET", @@ -65426,54 +69630,27 @@ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - "v2" + "resourceGroups", + ":resourceGroupId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + ] } }, - "status": "Unsupported Media Type" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 502, "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": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -65482,129 +69659,56 @@ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - "v2" + "resourceGroups", + ":resourceGroupId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + ] } }, - "status": "Too Many Requests" + "status": "Bad Gateway" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"error\"\n },\n {\n \"id\": \"\",\n \"resourceGroupId\": \"\",\n \"licenseId\": \"\",\n \"personId\": \"\",\n \"personOrgId\": \"\",\n \"status\": \"activated\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 404, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" - } - ], - "name": "OK", + "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": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - "v2" + "resourceGroups", + ":resourceGroupId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, - { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ + { + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + ] } }, - "status": "OK" + "status": "Not Found" }, { "_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", @@ -65613,54 +69717,27 @@ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - "v2" + "resourceGroups", + ":resourceGroupId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + ] } }, - "status": "Gateway Timeout" + "status": "Bad Request" }, { "_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": { "header": [], "method": "GET", @@ -65669,54 +69746,27 @@ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - "v2" + "resourceGroups", + ":resourceGroupId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + ] } }, - "status": "Conflict" + "status": "Gateway Timeout" }, { "_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", @@ -65725,54 +69775,27 @@ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - "v2" + "resourceGroups", + ":resourceGroupId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + ] } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_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", @@ -65781,146 +69804,66 @@ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - "v2" + "resourceGroups", + ":resourceGroupId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + ] } }, - "status": "Method Not Allowed" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 423, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"orgId\": \"\"\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": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "resourceGroup", - "memberships", - "v2" + "resourceGroups", + ":resourceGroupId" ], - "query": [ - { - "description": "List resource group memberships for a license, by ID.", - "key": "licenseId", - "value": "" - }, - { - "description": "List resource group memberships by ID.", - "key": "id", - "value": "" - }, - { - "description": "List resource group memberships for an organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "Limit resource group memberships to a specific status.", - "key": "status", - "value": "activated" - }, - { - "description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.", - "key": "type", - "value": "User" - }, + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ { - "description": "Limit the maximum number of resource group memberships in the response.", - "key": "max", - "value": "100" + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId" } - ], - "raw": "{{baseUrl}}/resourceGroup/memberships/v2?licenseId=&id=&orgId=&status=activated&type=User&max=100" + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" - } - ] - } - ], - "name": "Resource Group Memberships" - }, - { - "item": [ - { - "name": "List Resource Groups", - "request": { - "description": "List resource groups.\n\nUse query parameters to filter the response.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "resourceGroups" - ], - "query": [ - { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" - } - }, - "response": [ + "status": "OK" + }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 401, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], "method": "GET", @@ -65929,27 +69872,27 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups" + "resourceGroups", + ":resourceGroupId" ], - "query": [ + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId" } - ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" + ] } }, - "status": "Method Not Allowed" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 410, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -65958,27 +69901,27 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups" + "resourceGroups", + ":resourceGroupId" ], - "query": [ + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId" } - ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" + ] } }, - "status": "Bad Request" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 415, "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": "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", @@ -65987,27 +69930,56 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups" + "resourceGroups", + ":resourceGroupId" ], - "query": [ + "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "variable": [ { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" + "description": "The unique identifier for the resource group.", + "key": "resourceGroupId" } - ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" - }, + "status": "Unsupported Media Type" + } + ] + } + ], + "name": "Resource Groups" + }, + { + "item": [ + { + "name": "List Roles", + "request": { + "description": "List all roles. Must be called by an admin user.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "roles" + ], + "raw": "{{baseUrl}}/roles" + } + }, + "response": [ { "_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": { "header": [], "method": "GET", @@ -66016,19 +69988,12 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups" - ], - "query": [ - { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - } + "roles" ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" + "raw": "{{baseUrl}}/roles" } }, - "status": "Gateway Timeout" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -66045,16 +70010,9 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups" - ], - "query": [ - { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - } + "roles" ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" + "raw": "{{baseUrl}}/roles" } }, "status": "Not Found" @@ -66062,10 +70020,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 428, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -66074,27 +70032,20 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups" - ], - "query": [ - { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - } + "roles" ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" + "raw": "{{baseUrl}}/roles" } }, - "status": "Gone" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 403, "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": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], "method": "GET", @@ -66103,27 +70054,20 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups" - ], - "query": [ - { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - } + "roles" ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" + "raw": "{{baseUrl}}/roles" } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_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", @@ -66132,27 +70076,20 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups" - ], - "query": [ - { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - } + "roles" ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" + "raw": "{{baseUrl}}/roles" } }, - "status": "Bad Gateway" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 502, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -66161,27 +70098,20 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups" - ], - "query": [ - { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - } + "roles" ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" + "raw": "{{baseUrl}}/roles" } }, - "status": "Service Unavailable" + "status": "Bad Gateway" }, { "_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", @@ -66190,19 +70120,34 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups" + "roles" ], - "query": [ - { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - } + "raw": "{{baseUrl}}/roles" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_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}}" ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" + "path": [ + "roles" + ], + "raw": "{{baseUrl}}/roles" } }, - "status": "Precondition Required" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", @@ -66219,16 +70164,9 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups" - ], - "query": [ - { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - } + "roles" ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" + "raw": "{{baseUrl}}/roles" } }, "status": "Conflict" @@ -66236,10 +70174,10 @@ { "_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": { "header": [], "method": "GET", @@ -66248,23 +70186,16 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups" - ], - "query": [ - { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - } + "roles" ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" + "raw": "{{baseUrl}}/roles" } }, - "status": "Unsupported Media Type" + "status": "Gone" }, { "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"orgId\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"orgId\": \"\"\n }\n ]\n}", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -66287,20 +70218,35 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups" - ], - "query": [ - { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - } + "roles" ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" + "raw": "{{baseUrl}}/roles" } }, "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": [ + "roles" + ], + "raw": "{{baseUrl}}/roles" + } + }, + "status": "Too Many Requests" + }, { "_postman_previewlanguage": "text", "body": null, @@ -66316,16 +70262,9 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups" - ], - "query": [ - { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - } + "roles" ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" + "raw": "{{baseUrl}}/roles" } }, "status": "Unauthorized" @@ -66333,10 +70272,10 @@ { "_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", @@ -66345,27 +70284,20 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups" - ], - "query": [ - { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - } + "roles" ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" + "raw": "{{baseUrl}}/roles" } }, - "status": "Forbidden" + "status": "Service Unavailable" }, { "_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": { "header": [], "method": "GET", @@ -66374,26 +70306,41 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups" + "roles" ], - "query": [ - { - "description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - } + "raw": "{{baseUrl}}/roles" + } + }, + "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}}" ], - "raw": "{{baseUrl}}/resourceGroups?orgId=" + "path": [ + "roles" + ], + "raw": "{{baseUrl}}/roles" } }, - "status": "Internal Server Error" + "status": "Gateway Timeout" } ] }, { - "name": "Get Resource Group Details", + "name": "Get Role Details", "request": { - "description": "Shows details for a resource group, by ID.\n\nSpecify the resource group ID in the `resourceGroupId` parameter in the URI.", + "description": "Shows details for a role, by ID.\n\nSpecify the role ID in the `roleId` parameter in the URI.", "header": [ { "key": "Accept", @@ -66406,14 +70353,14 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups", - ":resourceGroupId" + "roles", + ":roleId" ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "raw": "{{baseUrl}}/roles/:roleId", "variable": [ { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId", + "description": "The unique identifier for the role.", + "key": "roleId", "value": "" } ] @@ -66423,39 +70370,10 @@ { "_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": [ - "resourceGroups", - ":resourceGroupId" - ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", - "variable": [ - { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId" - } - ] - } - }, - "status": "Too Many Requests" - }, - { - "_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": "GET", @@ -66464,27 +70382,27 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups", - ":resourceGroupId" + "roles", + ":roleId" ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "raw": "{{baseUrl}}/roles/:roleId", "variable": [ { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId" + "description": "The unique identifier for the role.", + "key": "roleId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "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", @@ -66493,19 +70411,19 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups", - ":resourceGroupId" + "roles", + ":roleId" ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "raw": "{{baseUrl}}/roles/:roleId", "variable": [ { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId" + "description": "The unique identifier for the role.", + "key": "roleId" } ] } }, - "status": "Service Unavailable" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -66522,14 +70440,14 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups", - ":resourceGroupId" + "roles", + ":roleId" ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "raw": "{{baseUrl}}/roles/:roleId", "variable": [ { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId" + "description": "The unique identifier for the role.", + "key": "roleId" } ] } @@ -66539,10 +70457,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 401, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], "method": "GET", @@ -66551,27 +70469,27 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups", - ":resourceGroupId" + "roles", + ":roleId" ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "raw": "{{baseUrl}}/roles/:roleId", "variable": [ { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId" + "description": "The unique identifier for the role.", + "key": "roleId" } ] } }, - "status": "Method Not Allowed" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 429, "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": "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", @@ -66580,27 +70498,27 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups", - ":resourceGroupId" + "roles", + ":roleId" ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "raw": "{{baseUrl}}/roles/:roleId", "variable": [ { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId" + "description": "The unique identifier for the role.", + "key": "roleId" } ] } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 415, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. 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": { "header": [], "method": "GET", @@ -66609,19 +70527,19 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups", - ":resourceGroupId" + "roles", + ":roleId" ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "raw": "{{baseUrl}}/roles/:roleId", "variable": [ { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId" + "description": "The unique identifier for the role.", + "key": "roleId" } ] } }, - "status": "Bad Gateway" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", @@ -66638,14 +70556,14 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups", - ":resourceGroupId" + "roles", + ":roleId" ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "raw": "{{baseUrl}}/roles/:roleId", "variable": [ { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId" + "description": "The unique identifier for the role.", + "key": "roleId" } ] } @@ -66667,14 +70585,14 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups", - ":resourceGroupId" + "roles", + ":roleId" ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "raw": "{{baseUrl}}/roles/:roleId", "variable": [ { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId" + "description": "The unique identifier for the role.", + "key": "roleId" } ] } @@ -66684,10 +70602,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": { "header": [], "method": "GET", @@ -66696,27 +70614,27 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups", - ":resourceGroupId" + "roles", + ":roleId" ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "raw": "{{baseUrl}}/roles/:roleId", "variable": [ { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId" + "description": "The unique identifier for the role.", + "key": "roleId" } ] } }, - "status": "Gateway Timeout" + "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": "GET", @@ -66725,27 +70643,27 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups", - ":resourceGroupId" + "roles", + ":roleId" ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "raw": "{{baseUrl}}/roles/:roleId", "variable": [ { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId" + "description": "The unique identifier for the role.", + "key": "roleId" } ] } }, - "status": "Forbidden" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 503, "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": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -66754,23 +70672,23 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups", - ":resourceGroupId" + "roles", + ":roleId" ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "raw": "{{baseUrl}}/roles/:roleId", "variable": [ { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId" + "description": "The unique identifier for the role.", + "key": "roleId" } ] } }, - "status": "Internal Server Error" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"orgId\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -66793,14 +70711,14 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups", - ":resourceGroupId" + "roles", + ":roleId" ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "raw": "{{baseUrl}}/roles/:roleId", "variable": [ { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId" + "description": "The unique identifier for the role.", + "key": "roleId" } ] } @@ -66810,10 +70728,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": { "header": [], "method": "GET", @@ -66822,27 +70740,27 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups", - ":resourceGroupId" + "roles", + ":roleId" ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "raw": "{{baseUrl}}/roles/:roleId", "variable": [ { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId" + "description": "The unique identifier for the role.", + "key": "roleId" } ] } }, - "status": "Unauthorized" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", @@ -66851,27 +70769,27 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups", - ":resourceGroupId" + "roles", + ":roleId" ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "raw": "{{baseUrl}}/roles/:roleId", "variable": [ { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId" + "description": "The unique identifier for the role.", + "key": "roleId" } ] } }, - "status": "Gone" + "status": "Bad Gateway" }, { "_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": "GET", @@ -66880,114 +70798,243 @@ "{{baseUrl}}" ], "path": [ - "resourceGroups", - ":resourceGroupId" + "roles", + ":roleId" ], - "raw": "{{baseUrl}}/resourceGroups/:resourceGroupId", + "raw": "{{baseUrl}}/roles/:roleId", "variable": [ { - "description": "The unique identifier for the resource group.", - "key": "resourceGroupId" + "description": "The unique identifier for the role.", + "key": "roleId" } ] } }, - "status": "Unsupported Media Type" + "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": [ + "roles", + ":roleId" + ], + "raw": "{{baseUrl}}/roles/:roleId", + "variable": [ + { + "description": "The unique identifier for the role.", + "key": "roleId" + } + ] + } + }, + "status": "Gone" } ] } ], - "name": "Resource Groups" + "name": "Roles" }, { "item": [ { - "name": "List Roles", + "name": "User bulk API", "request": { - "description": "List all roles. Must be called by an admin user.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\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\n**Usage**:\n\n1. The input JSON must conform to the following schema: 'urn:ietf:params:scim:api:messages:2.0:BulkRequest'.\n\n1. The request must be accompanied with a body in JSON format according to the standard SCIM schema definition.\n The maximum number of operations in a request is 100; an error is thrown if the limit is exceeded.\n\n1. `failOnErrors` parameter\n\n An integer specifies the number of errors that the service provider will accept before the operation is terminated and an error response is returned.\n It is OPTIONAL in a request.\n Maximum number of operations allowed to fail before the server stops processing the request. The value must be between 1 and 100.\n\n1. `operations` parameter\n\n Contains a list of bulk operations for POST/PATCH/DELETE operations. (REQUIRED)\n + `operations.method`\n\n The HTTP method of the current operation. Possible values are POST, PATCH or DELETE.\n + `operations.path`\n\n The Resource's relative path. If the method is POST the value must specify a Resource type endpoint;\n e.g., /Users or /Groups whereas all other method values must specify the path to a specific Resource;\n e.g., /Users/2819c223-7f76-453a-919d-413861904646.\n + `operations.data`\n\n The Resource data as it would appear for a single POST or PATCH Resource operation.\n It is REQUIRED in a request when method is POST and PATCH.\n Refer to corresponding wiki for SCIM 2.0 POST, PATCH and DELETE API.\n + `operations.bulkId`\n\n The transient identifier of a newly created resource, unique within a bulk request and created by the client.\n The bulkId serves as a surrogate resource id enabling clients to uniquely identify newly created resources in the response and cross-reference new resources in and across operations within a bulk request.\n It is REQUIRED when \"method\" is \"POST\".", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId", + "value": "" + } + ] } }, "response": [ { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + } + ] } }, - "status": "Internal Server Error" + "status": "Method Not Allowed" }, { "_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.", - "originalRequest": { - "header": [], - "method": "GET", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + } + ] } }, - "status": "Not Found" + "status": "Unsupported Media Type" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + } + ] } }, - "status": "Precondition Required" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -66997,320 +71044,666 @@ "header": [], "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + } + ] } }, "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 400, + "_postman_previewlanguage": "json", + "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}", + "code": 200, "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": "OK", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + } + ] } }, - "status": "Bad Request" + "status": "OK" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + } + ] } }, - "status": "Bad Gateway" + "status": "Not Found" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Request" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + } + ] } }, - "status": "Unsupported Media Type" + "status": "Precondition Required" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + } + ] } }, - "status": "Conflict" + "status": "Gone" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + } + ] } }, - "status": "Gone" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + } + ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + } + ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + } + ] } }, - "status": "Unauthorized" + "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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + } + ] } }, - "status": "Service Unavailable" + "status": "Too Many Requests" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + } + ] } }, - "status": "Method Not Allowed" + "status": "Bad Gateway" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles" + "identity", + "scim", + ":orgId", + "v2", + "Bulk" ], - "raw": "{{baseUrl}}/roles" + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + } + ] } }, - "status": "Gateway Timeout" + "status": "Locked (WebDAV) (RFC 4918)" } ] - }, + } + ], + "name": "Bulk Manage SCIM 2 Users and Groups" + }, + { + "item": [ { - "name": "Get Role Details", + "name": "Create a group", "request": { - "description": "Shows details for a role, by ID.\n\nSpecify the role ID in the `roleId` parameter in the URI.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "description": "Create a new group for a given organization. The group may optionally be created with group members.\n\n
\n\n**Authorization**\n\nOAuth token returned 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_group_admin`\n\n
\n\n**Usage**:\n\n1. The input JSON must conform to one of the following schemas:\n - `urn:ietf:params:scim:schemas:core:2.0:Group`\n - `urn:scim:schemas:extension:cisco:webexidentity:2.0:Group`\n\n1. Unrecognized schemas (ID/section) are ignored.\n\n1. Read-only attributes provided as input values are ignored.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId", "value": "" } ] @@ -67320,360 +71713,575 @@ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" } ] } }, - "status": "Conflict" + "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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" } ] } }, - "status": "Gateway Timeout" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 409, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" } ] } }, - "status": "Precondition Required" + "status": "Conflict" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, + "_postman_previewlanguage": "json", + "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"externalId\": \"\",\n \"members\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"provisionSource\": \"\",\n \"meta\": {\n \"organizationID\": \"\"\n },\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n}", + "code": 201, "cookie": [], - "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Created", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" } ] } }, - "status": "Unauthorized" + "status": "Created" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" } ] } }, - "status": "Too Many Requests" + "status": "Gone" }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" } ] } }, - "status": "Unsupported Media Type" + "status": "Forbidden" }, { "_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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" } ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" } ] } }, - "status": "Bad Request" + "status": "Bad Gateway" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" } ] } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" } ] } }, - "status": "Method Not Allowed" + "status": "Not Found" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" } ] } }, - "status": "Service Unavailable" + "status": "Method Not Allowed" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"name\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 429, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" } ] } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", @@ -67683,21 +72291,39 @@ "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" } ] } @@ -67707,122 +72333,157 @@ { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" } ] } }, - "status": "Bad Gateway" + "status": "Internal Server Error" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" } ] } }, - "status": "Forbidden" + "status": "Service Unavailable" }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "roles", - ":roleId" + "identity", + "scim", + ":orgId", + "v2", + "Groups" ], - "raw": "{{baseUrl}}/roles/:roleId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", "variable": [ { - "description": "The unique identifier for the role.", - "key": "roleId" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" } ] } }, - "status": "Gone" + "status": "Gateway Timeout" } ] - } - ], - "name": "Roles" - }, - { - "item": [ + }, { - "name": "User bulk API", + "name": "Search groups", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\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\n**Usage**:\n\n1. The input JSON must conform to the following schema: 'urn:ietf:params:scim:api:messages:2.0:BulkRequest'.\n\n1. The request must be accompanied with a body in JSON format according to the standard SCIM schema definition.\n The maximum number of operations in a request is 100; an error is thrown if the limit is exceeded.\n\n1. `failOnErrors` parameter\n\n An integer specifies the number of errors that the service provider will accept before the operation is terminated and an error response is returned.\n It is OPTIONAL in a request.\n Maximum number of operations allowed to fail before the server stops processing the request. The value must be between 1 and 100.\n\n1. `operations` parameter\n\n Contains a list of bulk operations for POST/PATCH/DELETE operations. (REQUIRED)\n + `operations.method`\n\n The HTTP method of the current operation. Possible values are POST, PATCH or DELETE.\n + `operations.path`\n\n The Resource's relative path. If the method is POST the value must specify a Resource type endpoint;\n e.g., /Users or /Groups whereas all other method values must specify the path to a specific Resource;\n e.g., /Users/2819c223-7f76-453a-919d-413861904646.\n + `operations.data`\n\n The Resource data as it would appear for a single POST or PATCH Resource operation.\n It is REQUIRED in a request when method is POST and PATCH.\n Refer to corresponding wiki for SCIM 2.0 POST, PATCH and DELETE API.\n + `operations.bulkId`\n\n The transient identifier of a newly created resource, unique within a bulk request and created by the client.\n The bulkId serves as a surrogate resource id enabling clients to uniquely identify newly created resources in the response and cross-reference new resources in and across operations within a bulk request.\n It is REQUIRED when \"method\" is \"POST\".", + "description": "Retrieve a list of groups in the organization.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n
\n\n**Authorization**\n\nAn OAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -67832,12 +72493,59 @@ "scim", ":orgId", "v2", - "Bulk" + "Groups" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId", "value": "" } @@ -67848,28 +72556,13 @@ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -67879,44 +72572,76 @@ "scim", ":orgId", "v2", - "Bulk" + "Groups" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" } ] } }, - "status": "Method Not Allowed" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 423, "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": "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -67926,91 +72651,155 @@ "scim", ":orgId", "v2", - "Bulk" + "Groups" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" } ] } }, - "status": "Unsupported Media Type" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "identity", + "scim", + ":orgId", + "v2", + "Groups" + ], + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Bulk" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" } ] } }, - "status": "Gateway Timeout" + "status": "Conflict" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68020,22 +72809,69 @@ "scim", ":orgId", "v2", - "Bulk" + "Groups" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" } ] } }, - "status": "Forbidden" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "json", - "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}", + "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"memberSize\": \"\",\n \"itemsPerPage\": \"\",\n \"startIndex\": \"\",\n \"Resources\": [\n {\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"externalId\": \"\",\n \"members\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"provisionSource\": \"\",\n \"meta\": {\n \"organizationID\": \"\"\n },\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n },\n {\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"externalId\": \"\",\n \"members\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"provisionSource\": \"\",\n \"meta\": {\n \"organizationID\": \"\"\n },\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -68046,27 +72882,13 @@ ], "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68076,12 +72898,59 @@ "scim", ":orgId", "v2", - "Bulk" + "Groups" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" } ] @@ -68097,23 +72966,8 @@ "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68123,12 +72977,59 @@ "scim", ":orgId", "v2", - "Bulk" + "Groups" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" } ] @@ -68139,28 +73040,13 @@ { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68170,44 +73056,76 @@ "scim", ":orgId", "v2", - "Bulk" + "Groups" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" } ] } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68217,44 +73135,76 @@ "scim", ":orgId", "v2", - "Bulk" + "Groups" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" } ] } }, - "status": "Precondition Required" + "status": "Forbidden" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68264,44 +73214,76 @@ "scim", ":orgId", "v2", - "Bulk" + "Groups" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" } ] } }, - "status": "Gone" + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "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}}" @@ -68311,44 +73293,76 @@ "scim", ":orgId", "v2", - "Bulk" + "Groups" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" } ] } }, - "status": "Service Unavailable" + "status": "Method Not Allowed" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68358,44 +73372,76 @@ "scim", ":orgId", "v2", - "Bulk" + "Groups" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" } ] } }, - "status": "Internal Server Error" + "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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68405,44 +73451,76 @@ "scim", ":orgId", "v2", - "Bulk" + "Groups" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" } ] } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 401, "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": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68452,44 +73530,76 @@ "scim", ":orgId", "v2", - "Bulk" + "Groups" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" } ] } }, - "status": "Conflict" + "status": "Unauthorized" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68499,44 +73609,76 @@ "scim", ":orgId", "v2", - "Bulk" + "Groups" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" } ] } }, - "status": "Too Many Requests" + "status": "Gone" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68546,44 +73688,76 @@ "scim", ":orgId", "v2", - "Bulk" + "Groups" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" } ] } }, - "status": "Bad Gateway" + "status": "Service Unavailable" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"failOnErrors\": \"\",\n \"operations\": [\n {\n \"method\": \"POST\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n },\n {\n \"method\": \"PATCH\",\n \"path\": \"\",\n \"data\": \"\",\n \"bulkId\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68593,51 +73767,79 @@ "scim", ":orgId", "v2", - "Bulk" + "Groups" + ], + "query": [ + { + "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", + "key": "filter", + "value": "" + }, + { + "description": "The attributes to return.", + "key": "attributes", + "value": "" + }, + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer indicating the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Default \"false\". If false, no members returned.", + "key": "includeMembers", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Gateway" } ] - } - ], - "name": "Bulk Manage SCIM 2 Users and Groups" - }, - { - "item": [ + }, { - "name": "Create a group", + "name": "Get a group", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "description": "Create a new group for a given organization. The group may optionally be created with group members.\n\n
\n\n**Authorization**\n\nOAuth token returned 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_group_admin`\n\n
\n\n**Usage**:\n\n1. The input JSON must conform to one of the following schemas:\n - `urn:ietf:params:scim:schemas:core:2.0:Group`\n - `urn:scim:schemas:extension:cisco:webexidentity:2.0:Group`\n\n1. Unrecognized schemas (ID/section) are ignored.\n\n1. Read-only attributes provided as input values are ignored.", + "description": "Retrieve details for a group, by ID.\n\nOptionally, members can be retrieved with this request. The maximum number of members returned is 500.\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- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68647,14 +73849,27 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId", "value": "" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId", + "value": "" } ] } @@ -68663,28 +73878,13 @@ { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68694,44 +73894,41 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Unsupported Media Type" + "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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68741,44 +73938,41 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Precondition Required" + "status": "Method Not Allowed" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68788,53 +73982,41 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Conflict" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"externalId\": \"\",\n \"members\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"provisionSource\": \"\",\n \"meta\": {\n \"organizationID\": \"\"\n },\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68844,44 +74026,41 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Created" + "status": "Forbidden" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68891,44 +74070,41 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Gone" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 400, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68938,44 +74114,41 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Forbidden" + "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68985,44 +74158,41 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Unauthorized" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 401, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -69032,44 +74202,41 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Bad Gateway" + "status": "Unauthorized" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -69079,44 +74246,41 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -69126,44 +74290,41 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Not Found" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 504, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method 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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -69173,44 +74334,41 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Method Not Allowed" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 502, "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": "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -69220,44 +74378,41 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Too Many Requests" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 415, "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": "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -69267,44 +74422,41 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 410, "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": "Gone: The requested resource is no longer available.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -69314,44 +74466,51 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Internal Server Error" + "status": "Gone" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, + "_postman_previewlanguage": "json", + "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"externalId\": \"\",\n \"members\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"provisionSource\": \"\",\n \"meta\": {\n \"organizationID\": \"\"\n },\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ]\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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -69361,44 +74520,41 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Service Unavailable" + "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -69408,32 +74564,58 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups", + "query": [ + { + "description": "Attributes to be excluded from the return.", + "key": "excludedAttributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Gateway Timeout" + "status": "Service Unavailable" } ] }, { - "name": "Search groups", + "name": "Update a group with PUT", "request": { - "description": "Retrieve a list of groups in the organization.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n
\n\n**Authorization**\n\nAn OAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "description": "Replace the contents of the Group.\n\nSpecify the group ID in the `groupId` parameter in the URI.\n\n
\n\n**Authorization**\n\nOAuth token returned 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_group_admin`\n\n
\n\n**Usage**:\n\n1. The input JSON must conform to one of the following schemas:\n - `urn:ietf:params:scim:schemas:core:2.0:Group`\n - `urn:scim:schemas:extension:cisco:webexidentity:2.0:Group`\n\n1. Unrecognized schemas (ID/section) are ignored.\n\n1. Read-only attributes provided as input values are ignored.\n\n1. The group `id` is not changed.\n\n1. All attributes are cleaned up if a new value is not provided by the client.\n\n1. The values, `meta` and `created` are not changed.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -69443,61 +74625,20 @@ "scim", ":orgId", "v2", - "Groups" - ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" - }, - { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" - } + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId", "value": "" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId", + "value": "" } ] } @@ -69506,13 +74647,28 @@ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -69522,234 +74678,101 @@ "scim", ":orgId", "v2", - "Groups" - ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" - }, - { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" - } + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" - } - ] - } - }, - "status": "Precondition Required" - }, - { - "_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": [ - "identity", - "scim", - ":orgId", - "v2", - "Groups" - ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", - "variable": [ - { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", - "key": "orgId" + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Internal Server Error" }, { "_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": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Groups" - ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" - }, - { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", + "path": [ + "identity", + "scim", + ":orgId", + "v2", + "Groups", + ":groupId" + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Conflict" + "status": "Not Found" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -69759,69 +74782,27 @@ "scim", ":orgId", "v2", - "Groups" - ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" - }, - { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" - } + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Unsupported Media Type" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "json", - "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"memberSize\": \"\",\n \"itemsPerPage\": \"\",\n \"startIndex\": \"\",\n \"Resources\": [\n {\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"externalId\": \"\",\n \"members\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"provisionSource\": \"\",\n \"meta\": {\n \"organizationID\": \"\"\n },\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n },\n {\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"externalId\": \"\",\n \"members\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"provisionSource\": \"\",\n \"meta\": {\n \"organizationID\": \"\"\n },\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n }\n ]\n}", + "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"externalId\": \"\",\n \"members\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"provisionSource\": \"\",\n \"meta\": {\n \"organizationID\": \"\"\n },\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n}", "code": 200, "cookie": [], "header": [ @@ -69832,13 +74813,27 @@ ], "name": "OK", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -69848,60 +74843,18 @@ "scim", ":orgId", "v2", - "Groups" - ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" - }, - { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" - } + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } @@ -69911,13 +74864,28 @@ { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -69927,76 +74895,49 @@ "scim", ":orgId", "v2", - "Groups" - ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" - }, - { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" - } + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Not Found" + "status": "Precondition Required" }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -70006,76 +74947,49 @@ "scim", ":orgId", "v2", - "Groups" - ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" - }, - { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" - } + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Internal Server Error" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 504, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -70085,76 +74999,49 @@ "scim", ":orgId", "v2", - "Groups" - ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" - }, - { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" - } + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Forbidden" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 502, "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": "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -70164,76 +75051,101 @@ "scim", ":orgId", "v2", - "Groups" + "Groups", + ":groupId" ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "variable": [ { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" + "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "key": "orgId" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" + "description": "A unique identifier for the group.", + "key": "groupId" + } + ] + } + }, + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", + "path": [ + "identity", + "scim", + ":orgId", + "v2", + "Groups", + ":groupId" + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Too Many Requests" + "status": "Unsupported Media Type" }, { "_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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -70243,76 +75155,49 @@ "scim", ":orgId", "v2", - "Groups" - ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" - }, - { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" - } + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Method Not Allowed" + "status": "Service Unavailable" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -70322,76 +75207,49 @@ "scim", ":orgId", "v2", - "Groups" - ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" - }, - { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" - } + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Gateway Timeout" + "status": "Conflict" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -70401,76 +75259,49 @@ "scim", ":orgId", "v2", - "Groups" - ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" - }, - { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" - } + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -70480,65 +75311,23 @@ "scim", ":orgId", "v2", - "Groups" - ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" - }, - { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" - } + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", @@ -70548,8 +75337,23 @@ "header": [], "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -70559,60 +75363,18 @@ "scim", ":orgId", "v2", - "Groups" - ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" - }, - { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" - } + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } @@ -70622,13 +75384,28 @@ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -70638,76 +75415,49 @@ "scim", ":orgId", "v2", - "Groups" - ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" - }, - { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" - } + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Service Unavailable" + "status": "Unauthorized" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"location_role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -70717,79 +75467,51 @@ "scim", ":orgId", "v2", - "Groups" - ], - "query": [ - { - "description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n", - "key": "filter", - "value": "" - }, - { - "description": "The attributes to return.", - "key": "attributes", - "value": "" - }, - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer indicating the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer indicating the desired maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Default \"false\". If false, no members returned.", - "key": "includeMembers", - "value": "" - }, - { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", - "value": "" - } + "Groups", + ":groupId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&includeMembers=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", "key": "orgId" + }, + { + "description": "A unique identifier for the group.", + "key": "groupId" } ] } }, - "status": "Bad Gateway" + "status": "Too Many Requests" } ] }, { - "name": "Get a group", + "name": "Update a group with PATCH", "request": { - "description": "Retrieve details for a group, by ID.\n\nOptionally, members can be retrieved with this request. The maximum number of members returned is 500.\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- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "description": "Update group attributes with PATCH.\n\nSpecify the group ID in the `groupId` parameter in the URI.\n\n
\n\n**Authorization**\n\nOAuth token returned 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_group_admin`\n\n
\n\n**Usage**:\n\n1. The input JSON must conform to one of the following schemas:\n - `urn:ietf:params:scim:schemas:core:2.0:Group`\n - `urn:scim:schemas:extension:cisco:webexidentity:2.0:Group`\n\n1. Unrecognized schemas (ID/section) are ignored.\n\n1. Read-only attributes provided as input values are ignored.\n\n1. Each operation on an attribute must be compatible with the attribute's mutability.\n\n1. 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 is used to add a new attribute value to an existing resource. The operation must contain a `value` member whose content specifies the value to be added. The 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`. The result of the add operation depends upon the target location indicated by `path` references:\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`. The 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 that are 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 that are 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 indicate the failure by returning 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.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -70802,14 +75524,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -70828,13 +75543,28 @@ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -70847,14 +75577,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -70867,18 +75590,33 @@ ] } }, - "status": "Too Many Requests" + "status": "Gateway Timeout" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -70891,14 +75629,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -70911,18 +75642,33 @@ ] } }, - "status": "Method Not Allowed" + "status": "Bad Gateway" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -70935,14 +75681,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -70955,18 +75694,33 @@ ] } }, - "status": "Not Found" + "status": "Conflict" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -70979,14 +75733,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -70999,18 +75746,33 @@ ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -71023,14 +75785,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -71043,18 +75798,33 @@ ] } }, - "status": "Conflict" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 410, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -71067,14 +75837,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -71087,18 +75850,42 @@ ] } }, - "status": "Bad Request" + "status": "Gone" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 428, + "_postman_previewlanguage": "json", + "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"externalId\": \"\",\n \"members\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"provisionSource\": \"\",\n \"meta\": {\n \"organizationID\": \"\"\n },\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"locationId\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\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": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -71111,14 +75898,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -71131,18 +75911,33 @@ ] } }, - "status": "Precondition Required" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 405, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -71155,14 +75950,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -71175,18 +75963,33 @@ ] } }, - "status": "Unauthorized" + "status": "Method Not Allowed" }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -71199,14 +76002,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -71219,18 +76015,33 @@ ] } }, - "status": "Internal Server Error" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 403, "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": "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -71243,14 +76054,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -71263,18 +76067,33 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Forbidden" }, { "_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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -71287,14 +76106,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -71307,18 +76119,33 @@ ] } }, - "status": "Gateway Timeout" + "status": "Unsupported Media Type" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -71331,14 +76158,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -71351,18 +76171,33 @@ ] } }, - "status": "Bad Gateway" + "status": "Service Unavailable" }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -71375,14 +76210,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -71395,18 +76223,33 @@ ] } }, - "status": "Unsupported Media Type" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 428, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -71419,14 +76262,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -71439,28 +76275,33 @@ ] } }, - "status": "Gone" + "status": "Precondition Required" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"externalId\": \"\",\n \"members\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"provisionSource\": \"\",\n \"meta\": {\n \"organizationID\": \"\"\n },\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -71473,14 +76314,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -71493,18 +76327,33 @@ ] } }, - "status": "OK" + "status": "Bad Request" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -71517,14 +76366,7 @@ "Groups", ":groupId" ], - "query": [ - { - "description": "Attributes to be excluded from the return.", - "key": "excludedAttributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId?excludedAttributes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -71537,35 +76379,16 @@ ] } }, - "status": "Service Unavailable" + "status": "Internal Server Error" } ] }, { - "name": "Update a group with PUT", + "name": "Delete a group", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "description": "Replace the contents of the Group.\n\nSpecify the group ID in the `groupId` parameter in the URI.\n\n
\n\n**Authorization**\n\nOAuth token returned 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_group_admin`\n\n
\n\n**Usage**:\n\n1. The input JSON must conform to one of the following schemas:\n - `urn:ietf:params:scim:schemas:core:2.0:Group`\n - `urn:scim:schemas:extension:cisco:webexidentity:2.0:Group`\n\n1. Unrecognized schemas (ID/section) are ignored.\n\n1. Read-only attributes provided as input values are ignored.\n\n1. The group `id` is not changed.\n\n1. All attributes are cleaned up if a new value is not provided by the client.\n\n1. The values, `meta` and `created` are not changed.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", + "description": "Remove a group from the system.\n\nSpecify the group ID in the `groupId` parameter in the URI.\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_group_admin`", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -71597,28 +76420,13 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 404, "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": "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -71644,33 +76452,18 @@ ] } }, - "status": "Internal Server Error" + "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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -71696,33 +76489,18 @@ ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -71748,42 +76526,18 @@ ] } }, - "status": "Method Not Allowed" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"externalId\": \"\",\n \"members\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"provisionSource\": \"\",\n \"meta\": {\n \"organizationID\": \"\"\n },\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -71809,7 +76563,7 @@ ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -71819,23 +76573,8 @@ "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -71871,23 +76610,8 @@ "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -71918,28 +76642,13 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 502, "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 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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -71965,33 +76674,18 @@ ] } }, - "status": "Gateway Timeout" + "status": "Bad Gateway" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -72017,33 +76711,18 @@ ] } }, - "status": "Bad Gateway" + "status": "Bad Request" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -72069,33 +76748,18 @@ ] } }, - "status": "Unsupported Media Type" + "status": "Too Many Requests" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -72121,33 +76785,18 @@ ] } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -72173,33 +76822,18 @@ ] } }, - "status": "Conflict" + "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -72225,33 +76859,18 @@ ] } }, - "status": "Forbidden" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 409, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -72277,33 +76896,18 @@ ] } }, - "status": "Bad Request" + "status": "Conflict" }, { "_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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -72329,33 +76933,18 @@ ] } }, - "status": "Gone" + "status": "No Content" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -72381,33 +76970,18 @@ ] } }, - "status": "Unauthorized" + "status": "Gateway Timeout" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"externalId\": \"\",\n \"members\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ]\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -72433,35 +77007,21 @@ ] } }, - "status": "Too Many Requests" + "status": "Unsupported Media Type" } ] }, { - "name": "Update a group with PATCH", + "name": "Get Group Members", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "description": "Update group attributes with PATCH.\n\nSpecify the group ID in the `groupId` parameter in the URI.\n\n
\n\n**Authorization**\n\nOAuth token returned 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_group_admin`\n\n
\n\n**Usage**:\n\n1. The input JSON must conform to one of the following schemas:\n - `urn:ietf:params:scim:schemas:core:2.0:Group`\n - `urn:scim:schemas:extension:cisco:webexidentity:2.0:Group`\n\n1. Unrecognized schemas (ID/section) are ignored.\n\n1. Read-only attributes provided as input values are ignored.\n\n1. Each operation on an attribute must be compatible with the attribute's mutability.\n\n1. 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 is used to add a new attribute value to an existing resource. The operation must contain a `value` member whose content specifies the value to be added. The 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`. The result of the add operation depends upon the target location indicated by `path` references:\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`. The 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 that are 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 that are 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 indicate the failure by returning 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": "Returns the members of a group.\n\n- The default maximum number of members returned is 500.\n\n- Control parameters are available to page through the members and to control the size of the results.\n\n- Long result sets are split into [pages](/docs/basics#pagination).\n\n**Note**\nLocation groups are different from SCIM groups. You cannot search for identities in a location via groups.\n\n
\n\n**Authorization**\n\nOAuth token returned by the Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -72472,9 +77032,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -72493,28 +77071,13 @@ { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -72525,9 +77088,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -72540,33 +77121,18 @@ ] } }, - "status": "Gateway Timeout" + "status": "Conflict" }, { "_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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -72577,9 +77143,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -72592,33 +77176,18 @@ ] } }, - "status": "Bad Gateway" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 401, "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": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -72629,9 +77198,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -72644,33 +77231,28 @@ ] } }, - "status": "Conflict" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 429, + "_postman_previewlanguage": "json", + "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"totalResults\": \"\",\n \"itemsPerPage\": \"\",\n \"startIndex\": \"\",\n \"members\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\"\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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -72681,9 +77263,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -72696,33 +77296,18 @@ ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -72733,9 +77318,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -72748,33 +77351,18 @@ ] } }, - "status": "Not Found" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 400, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -72785,9 +77373,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -72800,42 +77406,18 @@ ] } }, - "status": "Gone" + "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"externalId\": \"\",\n \"members\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n }\n ],\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"usage\": \"\",\n \"provisionSource\": \"\",\n \"meta\": {\n \"organizationID\": \"\"\n },\n \"owners\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"managedBy\": [\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"type\": \"\",\n \"id\": \"\",\n \"role\": \"\"\n }\n ],\n \"inheritances\": [\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"role\",\n \"value\": \"\",\n \"nested\": \"\",\n \"scope\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 428, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -72846,9 +77428,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -72861,33 +77461,18 @@ ] } }, - "status": "OK" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 423, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -72898,9 +77483,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -72909,37 +77512,22 @@ { "description": "A unique identifier for the group.", "key": "groupId" - } - ] - } - }, - "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + } + ] + } + }, + "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}}" @@ -72950,9 +77538,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -72965,33 +77571,18 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Internal Server Error" }, { "_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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -73002,9 +77593,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -73017,33 +77626,18 @@ ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -73054,9 +77648,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -73069,33 +77681,18 @@ ] } }, - "status": "Unsupported Media Type" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 502, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -73106,9 +77703,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -73121,33 +77736,18 @@ ] } }, - "status": "Service Unavailable" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 405, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -73158,9 +77758,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -73173,33 +77791,18 @@ ] } }, - "status": "Unauthorized" + "status": "Method Not Allowed" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -73210,9 +77813,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -73225,33 +77846,18 @@ ] } }, - "status": "Precondition Required" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 504, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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 \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -73262,9 +77868,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -73277,33 +77901,18 @@ ] } }, - "status": "Bad Request" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 503, "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": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -73314,9 +77923,27 @@ ":orgId", "v2", "Groups", - ":groupId" + ":groupId", + "Members" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "query": [ + { + "description": "The index to start for group pagination.", + "key": "startIndex", + "value": "" + }, + { + "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "key": "count", + "value": "" + }, + { + "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", + "key": "memberType", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", "variable": [ { "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", @@ -73329,16 +77956,40 @@ ] } }, - "status": "Internal Server Error" + "status": "Service Unavailable" } ] - }, + } + ], + "name": "SCIM 2 Groups" + }, + { + "item": [ { - "name": "Delete a group", + "name": "Create a user", "request": { - "description": "Remove a group from the system.\n\nSpecify the group ID in the `groupId` parameter in the URI.\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_group_admin`", - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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.\n\n The following roles cannot be assigned to a user:\n\n1. Location Admin\n\n2. Webex Site Admin", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73348,20 +77999,14 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId", "value": "" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId", - "value": "" } ] } @@ -73370,13 +78015,28 @@ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73386,34 +78046,44 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Not Found" + "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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73423,34 +78093,44 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 409, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. 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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73460,34 +78140,44 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Service Unavailable" + "status": "Conflict" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73497,34 +78187,44 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Unauthorized" + "status": "Unsupported Media Type" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73534,34 +78234,44 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Precondition Required" + "status": "Gone" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73571,34 +78281,44 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73608,34 +78328,44 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Bad Gateway" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 405, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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 \"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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73645,34 +78375,44 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Bad Request" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 403, "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": "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 \"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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73682,34 +78422,53 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "_postman_previewlanguage": "json", + "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"userName\": \"\",\n \"userType\": \"external_calling\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"active\": \"\",\n \"roles\": [\n {\n \"value\": \"\",\n \"type\": \"\",\n \"display\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\",\n \"display\": \"\"\n }\n ],\n \"name\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"middleName\": \"\",\n \"honorificPrefix\": \"\",\n \"honorificSuffix\": \"\"\n },\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"profileUrl\": \"\",\n \"title\": \"\",\n \"preferredLanguage\": \"\",\n \"locale\": \"\",\n \"externalId\": \"\",\n \"timezone\": \"\",\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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 \"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 \"displayName\": \"\",\n \"$ref\": \"\"\n }\n },\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\": {\n \"accountStatus\": \"pending\",\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}", + "code": 201, "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": "Created", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73719,34 +78478,44 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Internal Server Error" + "status": "Created" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 400, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "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 \"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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73756,34 +78525,44 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Gone" + "status": "Bad Request" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73793,34 +78572,44 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Method Not Allowed" + "status": "Internal Server Error" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73830,34 +78619,44 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Conflict" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 503, "cookie": [], "header": [], - "name": "No Content", + "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 \"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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73867,34 +78666,44 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "No Content" + "status": "Service Unavailable" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73904,34 +78713,44 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Gateway Timeout" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 423, "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": "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 \"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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -73941,30 +78760,25 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId" + "Users" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Unsupported Media Type" + "status": "Locked (WebDAV) (RFC 4918)" } ] }, { - "name": "Get Group Members", + "name": "Search users", "request": { - "description": "Returns the members of a group.\n\n- The default maximum number of members returned is 500.\n\n- Control parameters are available to page through the members and to control the size of the results.\n\n- Long result sets are split into [pages](/docs/basics#pagination).\n\n**Note**\nLocation groups are different from SCIM groups. You cannot search for identities in a location via groups.\n\n
\n\n**Authorization**\n\nOAuth token returned by the Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`", + "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- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`\n\n
", "header": [ { "key": "Accept", @@ -73981,38 +78795,66 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId", - "Members" + "Users" ], "query": [ { - "description": "The index to start for group pagination.", + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" + }, + { + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" + }, + { + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer for the 1-based index of the first query result. The default is 1.", "key": "startIndex", - "value": "" + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "description": "An integer for the maximum number of query results per page. The default is 100.", "key": "count", - "value": "" + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" + }, + { + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" + }, + { + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", "value": "" } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId", "value": "" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId", - "value": "" } ] } @@ -74021,10 +78863,10 @@ { "_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": { "header": [], "method": "GET", @@ -74037,49 +78879,78 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId", - "Members" + "Users" ], "query": [ { - "description": "The index to start for group pagination.", + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" + }, + { + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" + }, + { + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer for the 1-based index of the first query result. The default is 1.", "key": "startIndex", - "value": "" + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "description": "An integer for the maximum number of query results per page. The default is 100.", "key": "count", - "value": "" + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" + }, + { + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" + }, + { + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", "value": "" } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Conflict" + "status": "Gateway Timeout" }, { "_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", @@ -74092,49 +78963,78 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId", - "Members" + "Users" ], "query": [ { - "description": "The index to start for group pagination.", + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" + }, + { + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" + }, + { + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer for the 1-based index of the first query result. The default is 1.", "key": "startIndex", - "value": "" + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "description": "An integer for the maximum number of query results per page. The default is 100.", "key": "count", - "value": "" + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" + }, + { + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" + }, + { + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", "value": "" } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Not Found" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", @@ -74147,61 +79047,80 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId", - "Members" + "Users" ], "query": [ { - "description": "The index to start for group pagination.", + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" + }, + { + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" + }, + { + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer for the 1-based index of the first query result. The default is 1.", "key": "startIndex", - "value": "" + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "description": "An integer for the maximum number of query results per page. The default is 100.", "key": "count", - "value": "" + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" + }, + { + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" + }, + { + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", "value": "" } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Unauthorized" + "status": "Precondition Required" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"totalResults\": \"\",\n \"itemsPerPage\": \"\",\n \"startIndex\": \"\",\n \"members\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"display\": \"\"\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": [ @@ -74212,49 +79131,78 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId", - "Members" + "Users" ], "query": [ { - "description": "The index to start for group pagination.", + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" + }, + { + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" + }, + { + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer for the 1-based index of the first query result. The default is 1.", "key": "startIndex", - "value": "" + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "description": "An integer for the maximum number of query results per page. The default is 100.", "key": "count", - "value": "" + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" + }, + { + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" + }, + { + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", "value": "" } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "OK" + "status": "Bad Request" }, { "_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": { "header": [], "method": "GET", @@ -74267,49 +79215,162 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId", - "Members" + "Users" ], "query": [ { - "description": "The index to start for group pagination.", + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" + }, + { + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" + }, + { + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer for the 1-based index of the first query result. The default is 1.", "key": "startIndex", - "value": "" + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "description": "An integer for the maximum number of query results per page. The default is 100.", "key": "count", - "value": "" + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" + }, + { + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" + }, + { + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", "value": "" } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + } + ] + } + }, + "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": [ + "identity", + "scim", + ":orgId", + "v2", + "Users" + ], + "query": [ + { + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" }, { - "description": "A unique identifier for the group.", - "key": "groupId" + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" + }, + { + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer for the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer for the maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" + }, + { + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" + }, + { + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" } ] } }, - "status": "Unsupported Media Type" + "status": "Internal Server Error" }, { "_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": "GET", @@ -74322,49 +79383,78 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId", - "Members" + "Users" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" + }, + { + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" + }, + { + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer for the 1-based index of the first query result. The default is 1.", + "key": "startIndex", + "value": "" + }, + { + "description": "An integer for the maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", "value": "" } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Bad Request" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 502, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -74377,49 +79467,78 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId", - "Members" + "Users" ], "query": [ { - "description": "The index to start for group pagination.", + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" + }, + { + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" + }, + { + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer for the 1-based index of the first query result. The default is 1.", "key": "startIndex", - "value": "" + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "description": "An integer for the maximum number of query results per page. The default is 100.", "key": "count", - "value": "" + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" + }, + { + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" + }, + { + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", "value": "" } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Precondition Required" + "status": "Bad Gateway" }, { "_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", @@ -74432,49 +79551,78 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId", - "Members" + "Users" ], "query": [ { - "description": "The index to start for group pagination.", + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" + }, + { + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" + }, + { + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer for the 1-based index of the first query result. The default is 1.", "key": "startIndex", - "value": "" + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "description": "An integer for the maximum number of query results per page. The default is 100.", "key": "count", - "value": "" + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" + }, + { + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" + }, + { + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", "value": "" } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 404, "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": "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", @@ -74487,49 +79635,78 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId", - "Members" + "Users" ], "query": [ { - "description": "The index to start for group pagination.", + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" + }, + { + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" + }, + { + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer for the 1-based index of the first query result. The default is 1.", "key": "startIndex", - "value": "" + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "description": "An integer for the maximum number of query results per page. The default is 100.", "key": "count", - "value": "" + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" + }, + { + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" + }, + { + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", "value": "" } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_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", @@ -74542,51 +79719,90 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId", - "Members" + "Users" ], "query": [ { - "description": "The index to start for group pagination.", + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" + }, + { + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" + }, + { + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer for the 1-based index of the first query result. The default is 1.", "key": "startIndex", - "value": "" + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "description": "An integer for the maximum number of query results per page. The default is 100.", "key": "count", - "value": "" + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" + }, + { + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" + }, + { + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", "value": "" } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Too Many Requests" + "status": "Unsupported Media Type" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 403, + "_postman_previewlanguage": "json", + "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"totalResults\": \"\",\n \"itemsPerPage\": \"\",\n \"startIndex\": \"\",\n \"Resources\": [\n {\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"userName\": \"\",\n \"userType\": \"external_calling\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"active\": \"\",\n \"name\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"middleName\": \"\",\n \"honorificPrefix\": \"\",\n \"honorificSuffix\": \"\"\n },\n \"displayName\": \"\",\n \"nickName\": \"\",\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 \"profileUrl\": \"\",\n \"title\": \"\",\n \"preferredLanguage\": \"\",\n \"locale\": \"\",\n \"externalId\": \"\",\n \"timezone\": \"\",\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"groups\": [\n {\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n },\n {\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\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 \"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 \"displayName\": \"\",\n \"$ref\": \"\"\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 },\n {\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"userName\": \"\",\n \"userType\": \"user\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"active\": \"\",\n \"name\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"middleName\": \"\",\n \"honorificPrefix\": \"\",\n \"honorificSuffix\": \"\"\n },\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"profileUrl\": \"\",\n \"title\": \"\",\n \"preferredLanguage\": \"\",\n \"locale\": \"\",\n \"externalId\": \"\",\n \"timezone\": \"\",\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"groups\": [\n {\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n },\n {\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"resizable\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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 \"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 \"displayName\": \"\",\n \"$ref\": \"\"\n }\n },\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\": {\n \"accountStatus\": \"disabled\",\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 }\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": [ @@ -74597,49 +79813,78 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId", - "Members" + "Users" ], "query": [ { - "description": "The index to start for group pagination.", + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" + }, + { + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" + }, + { + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer for the 1-based index of the first query result. The default is 1.", "key": "startIndex", - "value": "" + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "description": "An integer for the maximum number of query results per page. The default is 100.", "key": "count", - "value": "" + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" + }, + { + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" + }, + { + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", "value": "" } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Forbidden" + "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": "GET", @@ -74652,41 +79897,70 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId", - "Members" + "Users" ], "query": [ { - "description": "The index to start for group pagination.", + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" + }, + { + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" + }, + { + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer for the 1-based index of the first query result. The default is 1.", "key": "startIndex", - "value": "" + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "description": "An integer for the maximum number of query results per page. The default is 100.", "key": "count", - "value": "" + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" + }, + { + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" + }, + { + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", "value": "" } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Bad Gateway" + "status": "Conflict" }, { "_postman_previewlanguage": "text", @@ -74707,104 +79981,78 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId", - "Members" + "Users" ], "query": [ { - "description": "The index to start for group pagination.", - "key": "startIndex", - "value": "" + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", "value": "" - } - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", - "variable": [ + }, { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", - "key": "orgId" + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" }, { - "description": "A unique identifier for the group.", - "key": "groupId" - } - ] - } - }, - "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": [ - "identity", - "scim", - ":orgId", - "v2", - "Groups", - ":groupId", - "Members" - ], - "query": [ + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, { - "description": "The index to start for group pagination.", + "description": "An integer for the 1-based index of the first query result. The default is 1.", "key": "startIndex", - "value": "" + "value": "" + }, + { + "description": "An integer for the maximum number of query results per page. The default is 100.", + "key": "count", + "value": "" + }, + { + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", - "key": "count", - "value": "" + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", "value": "" } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Gone" + "status": "Method Not Allowed" }, { "_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", @@ -74817,49 +80065,78 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId", - "Members" + "Users" ], "query": [ { - "description": "The index to start for group pagination.", + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" + }, + { + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" + }, + { + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer for the 1-based index of the first query result. The default is 1.", "key": "startIndex", - "value": "" + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "description": "An integer for the maximum number of query results per page. The default is 100.", "key": "count", - "value": "" + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" + }, + { + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" + }, + { + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", "value": "" } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Gateway Timeout" + "status": "Forbidden" }, { "_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", @@ -74872,74 +80149,84 @@ "scim", ":orgId", "v2", - "Groups", - ":groupId", - "Members" + "Users" ], "query": [ { - "description": "The index to start for group pagination.", + "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", + "key": "filter", + "value": "" + }, + { + "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", + "key": "attributes", + "value": "" + }, + { + "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", + "key": "excludedAttributes", + "value": "" + }, + { + "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", + "key": "sortBy", + "value": "" + }, + { + "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", + "key": "sortOrder", + "value": "" + }, + { + "description": "An integer for the 1-based index of the first query result. The default is 1.", "key": "startIndex", - "value": "" + "value": "" }, { - "description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.", + "description": "An integer for the maximum number of query results per page. The default is 100.", "key": "count", - "value": "" + "value": "" }, { - "description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.", - "key": "memberType", + "description": "Define whether the group information needs to be returned. The default is false.", + "key": "returnGroups", + "value": "" + }, + { + "description": "Define whether the group information with details needs to be returned. The default is false.", + "key": "includeGroupDetails", + "value": "" + }, + { + "description": "Returns groups with details of the specified group type.", + "key": "groupUsageTypes", "value": "" } ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members?startIndex=&count=&memberType=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", "variable": [ { - "description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.", + "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" - }, - { - "description": "A unique identifier for the group.", - "key": "groupId" } ] } }, - "status": "Service Unavailable" + "status": "Too Many Requests" } ] - } - ], - "name": "SCIM 2 Groups" - }, - { - "item": [ + }, { - "name": "Create a user", + "name": "Get a user", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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.\n\n The following roles cannot be assigned to a user:\n\n1. Location Admin\n\n2. Webex Site Admin", + "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- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`\n\n
", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -74949,66 +80236,25 @@ "scim", ":orgId", "v2", - "Users" + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId", "value": "" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId", + "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users" - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" - } - ] - } - }, - "status": "Bad Gateway" - }, { "_postman_previewlanguage": "text", "body": null, @@ -75017,23 +80263,8 @@ "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 \"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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -75043,13 +80274,18 @@ "scim", ":orgId", "v2", - "Users" + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } @@ -75059,28 +80295,13 @@ { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -75090,44 +80311,34 @@ "scim", ":orgId", "v2", - "Users" + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Conflict" + "status": "Method Not Allowed" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -75137,18 +80348,23 @@ "scim", ":orgId", "v2", - "Users" + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Unsupported Media Type" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", @@ -75158,23 +80374,8 @@ "header": [], "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -75184,13 +80385,18 @@ "scim", ":orgId", "v2", - "Users" + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } @@ -75200,28 +80406,13 @@ { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -75231,44 +80422,34 @@ "scim", ":orgId", "v2", - "Users" + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Gateway Timeout" + "status": "Bad Request" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -75278,44 +80459,34 @@ "scim", ":orgId", "v2", - "Users" + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Not Found" + "status": "Conflict" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -75325,44 +80496,34 @@ "scim", ":orgId", "v2", - "Users" + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Method Not Allowed" + "status": "Forbidden" }, { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -75372,53 +80533,44 @@ "scim", ":orgId", "v2", - "Users" + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Forbidden" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "json", "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"userName\": \"\",\n \"userType\": \"external_calling\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"active\": \"\",\n \"roles\": [\n {\n \"value\": \"\",\n \"type\": \"\",\n \"display\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\",\n \"display\": \"\"\n }\n ],\n \"name\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"middleName\": \"\",\n \"honorificPrefix\": \"\",\n \"honorificSuffix\": \"\"\n },\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"profileUrl\": \"\",\n \"title\": \"\",\n \"preferredLanguage\": \"\",\n \"locale\": \"\",\n \"externalId\": \"\",\n \"timezone\": \"\",\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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 \"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 \"displayName\": \"\",\n \"$ref\": \"\"\n }\n },\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\": {\n \"accountStatus\": \"pending\",\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}", - "code": 201, + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" - } - ], - "name": "Created", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, + } + ], + "name": "OK", + "originalRequest": { "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -75428,44 +80580,34 @@ "scim", ":orgId", "v2", - "Users" + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Created" + "status": "OK" }, { "_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 \"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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -75475,44 +80617,34 @@ "scim", ":orgId", "v2", - "Users" + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Bad Request" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 404, "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": "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 \"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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -75522,44 +80654,34 @@ "scim", ":orgId", "v2", - "Users" + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_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 \"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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -75569,44 +80691,34 @@ "scim", ":orgId", "v2", - "Users" + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Precondition Required" + "status": "Gateway Timeout" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -75616,18 +80728,23 @@ "scim", ":orgId", "v2", - "Users" + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -75637,23 +80754,8 @@ "header": [], "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -75663,13 +80765,18 @@ "scim", ":orgId", "v2", - "Users" + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } @@ -75684,23 +80791,8 @@ "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 \"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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -75710,32 +80802,88 @@ "scim", ":orgId", "v2", - "Users" + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_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": [ + "identity", + "scim", + ":orgId", + "v2", + "Users", + ":userId" + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", + "variable": [ + { + "description": "Webex Identity assigned organization identifier for user's organization.", + "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" + } + ] + } + }, + "status": "Unsupported Media Type" } ] }, { - "name": "Search users", + "name": "Update a user with PUT", "request": { - "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- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`\n\n
", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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": "
\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\n5. User `id` will not be changed.\n\n6. `meta`.`created` will not be changed.\n\n7. The PUT API replaces the contents of the user's data with the data in the request body. All attributes specified in the request body will replace all existing attributes for the `userId` specified in the URL. Should you wish to replace or change some attributes as opposed to all attributes please refer to the SCIM PATCH operation https://developer.webex.com/docs/api/v1/scim2-user/update-a-user-with-patch.\n\n
\n\n**NOTE**:\n\nOnce a user's role or managed roles are changed, all tokens associated with that user will be invalidated.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -75745,81 +80893,59 @@ "scim", ":orgId", "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" - } + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId", "value": "" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId", + "value": "" } ] } }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 504, + "_postman_previewlanguage": "json", + "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"userName\": \"\",\n \"userType\": \"external_calling\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"active\": \"\",\n \"roles\": [\n {\n \"value\": \"\",\n \"type\": \"\",\n \"display\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\",\n \"display\": \"\"\n }\n ],\n \"name\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"middleName\": \"\",\n \"honorificPrefix\": \"\",\n \"honorificSuffix\": \"\"\n },\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"profileUrl\": \"\",\n \"title\": \"\",\n \"preferredLanguage\": \"\",\n \"locale\": \"\",\n \"externalId\": \"\",\n \"timezone\": \"\",\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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 \"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 \"displayName\": \"\",\n \"$ref\": \"\"\n }\n },\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\": {\n \"accountStatus\": \"pending\",\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}", + "code": 200, "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": "OK", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -75829,81 +80955,49 @@ "scim", ":orgId", "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" - } + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Gateway Timeout" + "status": "OK" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -75913,81 +81007,49 @@ "scim", ":orgId", "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" - } + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 409, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "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 \"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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -75997,81 +81059,49 @@ "scim", ":orgId", "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" - } + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Precondition Required" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 410, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -76081,81 +81111,49 @@ "scim", ":orgId", "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" - } + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Bad Request" + "status": "Gone" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -76165,70 +81163,23 @@ "scim", ":orgId", "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" - } + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Service Unavailable" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", @@ -76238,8 +81189,23 @@ "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -76249,65 +81215,18 @@ "scim", ":orgId", "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" - } + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } @@ -76317,13 +81236,28 @@ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -76333,81 +81267,49 @@ "scim", ":orgId", "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" - } + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -76417,81 +81319,49 @@ "scim", ":orgId", "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" - } + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Bad Gateway" + "status": "Too Many Requests" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -76501,70 +81371,23 @@ "scim", ":orgId", "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" - } + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Gone" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", @@ -76574,8 +81397,23 @@ "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -76585,65 +81423,18 @@ "scim", ":orgId", "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" - } + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } @@ -76658,8 +81449,23 @@ "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -76669,65 +81475,18 @@ "scim", ":orgId", "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" - } + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } @@ -76735,25 +81494,30 @@ "status": "Unsupported Media Type" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"totalResults\": \"\",\n \"itemsPerPage\": \"\",\n \"startIndex\": \"\",\n \"Resources\": [\n {\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"userName\": \"\",\n \"userType\": \"external_calling\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"active\": \"\",\n \"name\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"middleName\": \"\",\n \"honorificPrefix\": \"\",\n \"honorificSuffix\": \"\"\n },\n \"displayName\": \"\",\n \"nickName\": \"\",\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 \"profileUrl\": \"\",\n \"title\": \"\",\n \"preferredLanguage\": \"\",\n \"locale\": \"\",\n \"externalId\": \"\",\n \"timezone\": \"\",\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"groups\": [\n {\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n },\n {\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\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 \"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 \"displayName\": \"\",\n \"$ref\": \"\"\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 },\n {\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"userName\": \"\",\n \"userType\": \"user\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"active\": \"\",\n \"name\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"middleName\": \"\",\n \"honorificPrefix\": \"\",\n \"honorificSuffix\": \"\"\n },\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"profileUrl\": \"\",\n \"title\": \"\",\n \"preferredLanguage\": \"\",\n \"locale\": \"\",\n \"externalId\": \"\",\n \"timezone\": \"\",\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"pager\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"groups\": [\n {\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n },\n {\n \"value\": \"\",\n \"display\": \"\",\n \"$ref\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"resizable\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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 \"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 \"displayName\": \"\",\n \"$ref\": \"\"\n }\n },\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\": {\n \"accountStatus\": \"disabled\",\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 }\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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -76763,81 +81527,49 @@ "scim", ":orgId", "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" - } + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "OK" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 401, "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": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -76847,165 +81579,101 @@ "scim", ":orgId", "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" - } + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Conflict" + "status": "Unauthorized" }, { "_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": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } + }, + "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "path": [ + "identity", + "scim", + ":orgId", + "v2", + "Users", + ":userId" + ], + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Method Not Allowed" + "status": "Bad Request" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -77015,81 +81683,49 @@ "scim", ":orgId", "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" - } + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Forbidden" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 503, "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": "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 \"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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -77099,84 +81735,51 @@ "scim", ":orgId", "v2", - "Users" - ], - "query": [ - { - "description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core**                              | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |", - "key": "filter", - "value": "" - }, - { - "description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned", - "key": "attributes", - "value": "" - }, - { - "description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned", - "key": "excludedAttributes", - "value": "" - }, - { - "description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.", - "key": "sortBy", - "value": "" - }, - { - "description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.", - "key": "sortOrder", - "value": "" - }, - { - "description": "An integer for the 1-based index of the first query result. The default is 1.", - "key": "startIndex", - "value": "" - }, - { - "description": "An integer for the maximum number of query results per page. The default is 100.", - "key": "count", - "value": "" - }, - { - "description": "Define whether the group information needs to be returned. The default is false.", - "key": "returnGroups", - "value": "" - }, - { - "description": "Define whether the group information with details needs to be returned. The default is false.", - "key": "includeGroupDetails", - "value": "" - }, - { - "description": "Returns groups with details of the specified group type.", - "key": "groupUsageTypes", - "value": "" - } + "Users", + ":userId" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users?filter=&attributes=&excludedAttributes=&sortBy=&sortOrder=&startIndex=&count=&returnGroups=&includeGroupDetails=&groupUsageTypes=", + "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", "variable": [ { "description": "Webex Identity assigned organization identifier for user's organization.", "key": "orgId" + }, + { + "description": "Webex Identity assigned user identifier.", + "key": "userId" } ] } }, - "status": "Too Many Requests" + "status": "Service Unavailable" } ] }, { - "name": "Get a user", + "name": "Update a user with PATCH", "request": { - "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- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`\n\n
", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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.\n\n The following roles cannot be assigned to a user:\n\n1. Location Admin\n\n2. Webex Site Admin \n\n
\n\n**NOTE**:\n\nOnce a user's role or managed roles are changed, all tokens associated with that user will be invalidated.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77208,13 +81811,28 @@ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77240,18 +81858,33 @@ ] } }, - "status": "Too Many Requests" + "status": "Gateway Timeout" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77277,18 +81910,33 @@ ] } }, - "status": "Method Not Allowed" + "status": "Bad Gateway" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77314,18 +81962,33 @@ ] } }, - "status": "Precondition Required" + "status": "Internal Server Error" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77351,18 +82014,33 @@ ] } }, - "status": "Gone" + "status": "Conflict" }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77388,18 +82066,33 @@ ] } }, - "status": "Bad Request" + "status": "Unauthorized" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77425,18 +82118,33 @@ ] } }, - "status": "Conflict" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 400, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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 \"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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77462,18 +82170,42 @@ ] } }, - "status": "Forbidden" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, + "_postman_previewlanguage": "json", + "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"userName\": \"\",\n \"userType\": \"external_calling\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"active\": \"\",\n \"roles\": [\n {\n \"value\": \"\",\n \"type\": \"\",\n \"display\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\",\n \"display\": \"\"\n }\n ],\n \"name\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"middleName\": \"\",\n \"honorificPrefix\": \"\",\n \"honorificSuffix\": \"\"\n },\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"profileUrl\": \"\",\n \"title\": \"\",\n \"preferredLanguage\": \"\",\n \"locale\": \"\",\n \"externalId\": \"\",\n \"timezone\": \"\",\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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 \"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 \"displayName\": \"\",\n \"$ref\": \"\"\n }\n },\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\": {\n \"accountStatus\": \"pending\",\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}", + "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 \"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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77499,28 +82231,33 @@ ] } }, - "status": "Service Unavailable" + "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"userName\": \"\",\n \"userType\": \"external_calling\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"active\": \"\",\n \"roles\": [\n {\n \"value\": \"\",\n \"type\": \"\",\n \"display\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\",\n \"display\": \"\"\n }\n ],\n \"name\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"middleName\": \"\",\n \"honorificPrefix\": \"\",\n \"honorificSuffix\": \"\"\n },\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"profileUrl\": \"\",\n \"title\": \"\",\n \"preferredLanguage\": \"\",\n \"locale\": \"\",\n \"externalId\": \"\",\n \"timezone\": \"\",\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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 \"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 \"displayName\": \"\",\n \"$ref\": \"\"\n }\n },\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\": {\n \"accountStatus\": \"pending\",\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}", - "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77546,18 +82283,33 @@ ] } }, - "status": "OK" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77583,18 +82335,33 @@ ] } }, - "status": "Bad Gateway" + "status": "Not Found" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77620,18 +82387,33 @@ ] } }, - "status": "Not Found" + "status": "Precondition Required" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77657,18 +82439,33 @@ ] } }, - "status": "Gateway Timeout" + "status": "Forbidden" }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77694,18 +82491,33 @@ ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 405, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77731,18 +82543,33 @@ ] } }, - "status": "Unauthorized" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 415, "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": "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 \"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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77768,18 +82595,33 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unsupported Media Type" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -77805,35 +82647,16 @@ ] } }, - "status": "Unsupported Media Type" + "status": "Service Unavailable" } ] }, { - "name": "Update a user with PUT", + "name": "Delete a user", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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": "
\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\n5. User `id` will not be changed.\n\n6. `meta`.`created` will not be changed.\n\n7. The PUT API replaces the contents of the user's data with the data in the request body. All attributes specified in the request body will replace all existing attributes for the `userId` specified in the URL. Should you wish to replace or change some attributes as opposed to all attributes please refer to the SCIM PATCH operation https://developer.webex.com/docs/api/v1/scim2-user/update-a-user-with-patch.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", + "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
", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -77863,39 +82686,15 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"userName\": \"\",\n \"userType\": \"external_calling\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"active\": \"\",\n \"roles\": [\n {\n \"value\": \"\",\n \"type\": \"\",\n \"display\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\",\n \"display\": \"\"\n }\n ],\n \"name\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"middleName\": \"\",\n \"honorificPrefix\": \"\",\n \"honorificSuffix\": \"\"\n },\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"profileUrl\": \"\",\n \"title\": \"\",\n \"preferredLanguage\": \"\",\n \"locale\": \"\",\n \"externalId\": \"\",\n \"timezone\": \"\",\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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 \"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 \"displayName\": \"\",\n \"$ref\": \"\"\n }\n },\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\": {\n \"accountStatus\": \"pending\",\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}", - "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 \"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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -77921,33 +82720,18 @@ ] } }, - "status": "OK" + "status": "Method Not Allowed" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -77973,33 +82757,18 @@ ] } }, - "status": "Gateway Timeout" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -78025,33 +82794,18 @@ ] } }, - "status": "Conflict" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 400, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "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 \"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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -78077,33 +82831,18 @@ ] } }, - "status": "Gone" + "status": "Bad Request" }, { "_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 \"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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -78129,33 +82868,18 @@ ] } }, - "status": "Precondition Required" + "status": "Gateway Timeout" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -78181,33 +82905,18 @@ ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -78233,33 +82942,18 @@ ] } }, - "status": "Forbidden" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 403, "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": "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 \"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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -78285,33 +82979,18 @@ ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 410, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -78337,33 +83016,18 @@ ] } }, - "status": "Bad Gateway" + "status": "Gone" }, { "_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 \"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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -78389,33 +83053,18 @@ ] } }, - "status": "Not Found" + "status": "Precondition Required" }, { "_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 \"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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -78441,33 +83090,18 @@ ] } }, - "status": "Unsupported Media Type" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 500, "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": "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 \"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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -78493,33 +83127,18 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 404, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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 \"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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -78542,36 +83161,21 @@ "description": "Webex Identity assigned user identifier.", "key": "userId" } - ] - } - }, - "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + ] + } + }, + "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": { + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -78597,33 +83201,18 @@ ] } }, - "status": "Bad Request" + "status": "Unsupported Media Type" }, { "_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", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -78649,33 +83238,18 @@ ] } }, - "status": "Method Not Allowed" + "status": "No Content" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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 \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"fax\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"resizable\",\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\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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\": \"fraud_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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -78701,35 +83275,21 @@ ] } }, - "status": "Service Unavailable" + "status": "Unauthorized" } ] }, { - "name": "Update a user with PATCH", + "name": "Get Me", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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.\n\n The following roles cannot be assigned to a user:\n\n1. Location Admin\n\n2. Webex Site Admin", + "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- `identity:people_read`\n\n
\n\nThe API can be used by any user to retrieve user information using their own access token.\n\n
", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78737,52 +83297,24 @@ "path": [ "identity", "scim", - ":orgId", "v2", "Users", - ":userId" + "me" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId", - "value": "" - }, - { - "description": "Webex Identity assigned user identifier.", - "key": "userId", - "value": "" - } - ] + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" } }, "response": [ { "_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 \"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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78790,51 +83322,25 @@ "path": [ "identity", "scim", - ":orgId", "v2", "Users", - ":userId" + "me" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" - }, - { - "description": "Webex Identity assigned user identifier.", - "key": "userId" - } - ] + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" } }, - "status": "Gateway Timeout" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 401, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78842,25 +83348,66 @@ "path": [ "identity", "scim", - ":orgId", "v2", "Users", - ":userId" + "me" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" - }, - { - "description": "Webex Identity assigned user identifier.", - "key": "userId" - } - ] + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" } }, - "status": "Bad Gateway" + "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": [ + "identity", + "scim", + "v2", + "Users", + "me" + ], + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + } + }, + "status": "Unsupported Media Type" + }, + { + "_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": [ + "identity", + "scim", + "v2", + "Users", + "me" + ], + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + } + }, + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", @@ -78870,23 +83417,8 @@ "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 \"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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78894,26 +83426,41 @@ "path": [ "identity", "scim", - ":orgId", "v2", "Users", - ":userId" + "me" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" - }, - { - "description": "Webex Identity assigned user identifier.", - "key": "userId" - } - ] + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" } }, "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": [ + "identity", + "scim", + "v2", + "Users", + "me" + ], + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, { "_postman_previewlanguage": "text", "body": null, @@ -78922,23 +83469,8 @@ "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 \"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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78946,22 +83478,11 @@ "path": [ "identity", "scim", - ":orgId", "v2", "Users", - ":userId" + "me" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" - }, - { - "description": "Webex Identity assigned user identifier.", - "key": "userId" - } - ] + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" } }, "status": "Conflict" @@ -78969,28 +83490,13 @@ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78998,51 +83504,25 @@ "path": [ "identity", "scim", - ":orgId", "v2", "Users", - ":userId" + "me" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" - }, - { - "description": "Webex Identity assigned user identifier.", - "key": "userId" - } - ] + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -79050,51 +83530,25 @@ "path": [ "identity", "scim", - ":orgId", "v2", "Users", - ":userId" + "me" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" - }, - { - "description": "Webex Identity assigned user identifier.", - "key": "userId" - } - ] + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" } }, - "status": "Gone" + "status": "Too Many Requests" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -79102,25 +83556,92 @@ "path": [ "identity", "scim", - ":orgId", "v2", "Users", - ":userId" + "me" + ], + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + } + }, + "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": [ + "identity", + "scim", + "v2", + "Users", + "me" + ], + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + } + }, + "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": [ + "identity", + "scim", + "v2", + "Users", + "me" + ], + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + } + }, + "status": "Gateway Timeout" + }, + { + "_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": [ + "identity", + "scim", + "v2", + "Users", + "me" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" - }, - { - "description": "Webex Identity assigned user identifier.", - "key": "userId" - } - ] + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" } }, - "status": "Bad Request" + "status": "Gone" }, { "_postman_previewlanguage": "json", @@ -79135,27 +83656,13 @@ ], "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -79163,22 +83670,11 @@ "path": [ "identity", "scim", - ":orgId", "v2", "Users", - ":userId" + "me" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" - }, - { - "description": "Webex Identity assigned user identifier.", - "key": "userId" - } - ] + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" } }, "status": "OK" @@ -79186,28 +83682,13 @@ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -79215,25 +83696,14 @@ "path": [ "identity", "scim", - ":orgId", "v2", "Users", - ":userId" + "me" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" - }, - { - "description": "Webex Identity assigned user identifier.", - "key": "userId" - } - ] + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", @@ -79243,731 +83713,1061 @@ "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" - } + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "identity", + "scim", + "v2", + "Users", + "me" + ], + "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + } + }, + "status": "Not Found" + } + ] + } + ], + "name": "SCIM 2 Users" + }, + { + "item": [ + { + "name": "List Security Audit Events", + "request": { + "description": "List Security Audit Events. This API currently returns user sign-in and sign-out data.\nTo call this API the `audit:events_read` scope must be selected for the Integration or Service App and authorized by a Full Admin.\n\nSeveral query parameters are available to filter the response.\n\nLong result sets will be split into multiple [pages](/docs/basics#pagination)\n\n**NOTE**: A maximum of one year of audit events can be returned per request.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "securityAudit", + "events" + ], + "query": [ + { + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" + }, + { + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, + { + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" + }, + { + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=&eventCategories=" + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"data\": {\n \"actorOrgName\": \"\",\n \"eventDescription\": \"\",\n \"actorName\": \"\",\n \"actorEmail\": \"\",\n \"actorUserAgent\": \"\",\n \"trackingId\": \"\",\n \"eventCategory\": \"\",\n \"actorIp\": \"\",\n \"actionText\": \"\"\n },\n \"created\": \"\",\n \"actorOrgId\": \"\",\n \"id\": \"\",\n \"actorId\": \"\"\n },\n {\n \"data\": {\n \"actorOrgName\": \"\",\n \"eventDescription\": \"\",\n \"actorName\": \"\",\n \"actorEmail\": \"\",\n \"actorUserAgent\": \"\",\n \"trackingId\": \"\",\n \"eventCategory\": \"\",\n \"actorIp\": \"\",\n \"actionText\": \"\"\n },\n \"created\": \"\",\n \"actorOrgId\": \"\",\n \"id\": \"\",\n \"actorId\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "", + "type": "text/plain" }, - "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}" + "disabled": false, + "key": "link", + "value": "" }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Content-Disposition", + "value": "" + } + ], + "name": "OK", + "originalRequest": { "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" + "admin", + "securityAudit", + "events" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, + { + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" + }, + { + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" } }, - "status": "Not Found" + "status": "OK" }, { "_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 \"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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" + "admin", + "securityAudit", + "events" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, + { + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" + }, + { + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" } }, - "status": "Precondition Required" + "status": "Gateway Timeout" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" + "admin", + "securityAudit", + "events" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, + { + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" + }, + { + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" } }, - "status": "Forbidden" + "status": "Not Found" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" + "admin", + "securityAudit", + "events" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, + { + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" + }, + { + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" } }, - "status": "Too Many Requests" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 423, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "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 \"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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" + "admin", + "securityAudit", + "events" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ + "query": [ + { + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" + }, + { + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" } }, - "status": "Method Not Allowed" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" + "admin", + "securityAudit", + "events" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, + { + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" + }, + { + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" } }, - "status": "Unsupported Media Type" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 403, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "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 \"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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" + "admin", + "securityAudit", + "events" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, + { + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" + }, + { + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" } }, - "status": "Service Unavailable" - } - ] - }, - { - "name": "Delete a user", - "request": { - "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
", - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" - ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ - { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId", - "value": "" - }, - { - "description": "Webex Identity assigned user identifier.", - "key": "userId", - "value": "" - } - ] - } - }, - "response": [ + "status": "Forbidden" + }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" + "admin", + "securityAudit", + "events" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, + { + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" + }, + { + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" } }, - "status": "Method Not Allowed" + "status": "Bad Gateway" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" + "admin", + "securityAudit", + "events" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, + { + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" + }, + { + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Too Many Requests" }, { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" + "admin", + "securityAudit", + "events" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, + { + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" + }, + { + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" } }, - "status": "Bad Gateway" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 410, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" + "admin", + "securityAudit", + "events" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, + { + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" + }, + { + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" } }, - "status": "Bad Request" + "status": "Gone" }, { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" + "admin", + "securityAudit", + "events" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, + { + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" + }, + { + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" } }, - "status": "Gateway Timeout" + "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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" + "admin", + "securityAudit", + "events" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" + }, + { + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, + { + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" + }, + { + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" } }, - "status": "Too Many Requests" + "status": "Conflict" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" + "admin", + "securityAudit", + "events" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, + { + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" + }, + { + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" } }, - "status": "Service Unavailable" + "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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" + "admin", + "securityAudit", + "events" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, + { + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" + }, + { + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" } }, - "status": "Forbidden" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 400, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "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}}" ], "path": [ - "identity", - "scim", - ":orgId", - "v2", - "Users", - ":userId" + "admin", + "securityAudit", + "events" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", - "variable": [ + "query": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", - "key": "orgId" + "description": "List events in this organization, by ID.", + "key": "orgId", + "value": "" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "List events which occurred after a specific date and time.", + "key": "startTime", + "value": "" + }, + { + "description": "List events which occurred before a specific date and time.", + "key": "endTime", + "value": "" + }, + { + "description": "List events performed by this person, by ID.", + "key": "actorId", + "value": "" + }, + { + "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", + "key": "max", + "value": "100" + }, + { + "description": "List events, by event categories.", + "key": "eventCategories", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" } }, - "status": "Gone" - }, + "status": "Bad Request" + } + ] + } + ], + "name": "Security Audit Events" + }, + { + "item": [ + { + "name": "Get an Organization Setting", + "request": { + "description": "This endpoint retrieves the specified setting for the given organization and is accessible with the scope 'identity:organizations_read'.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "settings", + "organizations", + ":orgId", + "settings", + ":settingKey" + ], + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId", + "value": "" + }, + { + "description": "The key of the setting.", + "key": "settingKey", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "text", "body": null, @@ -79977,28 +84777,27 @@ "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}}" ], "path": [ - "identity", - "scim", + "settings", + "organizations", ":orgId", - "v2", - "Users", - ":userId" + "settings", + ":settingKey" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The Webex organization id in Control Hub UUID or API orgId format.", "key": "orgId" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "The key of the setting.", + "key": "settingKey" } ] } @@ -80008,286 +84807,236 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 401, "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": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", + "settings", + "organizations", ":orgId", - "v2", - "Users", - ":userId" + "settings", + ":settingKey" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The Webex organization id in Control Hub UUID or API orgId format.", "key": "orgId" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "The key of the setting.", + "key": "settingKey" } ] } }, - "status": "Conflict" + "status": "Unauthorized" }, { "_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", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", + "settings", + "organizations", ":orgId", - "v2", - "Users", - ":userId" + "settings", + ":settingKey" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The Webex organization id in Control Hub UUID or API orgId format.", "key": "orgId" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "The key of the setting.", + "key": "settingKey" } ] } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", + "settings", + "organizations", ":orgId", - "v2", - "Users", - ":userId" + "settings", + ":settingKey" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The Webex organization id in Control Hub UUID or API orgId format.", "key": "orgId" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "The key of the setting.", + "key": "settingKey" } ] } }, - "status": "Not Found" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 423, "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": "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}}" ], "path": [ - "identity", - "scim", + "settings", + "organizations", ":orgId", - "v2", - "Users", - ":userId" + "settings", + ":settingKey" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The Webex organization id in Control Hub UUID or API orgId format.", "key": "orgId" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "The key of the setting.", + "key": "settingKey" } ] } }, - "status": "Unsupported Media Type" + "status": "Locked (WebDAV) (RFC 4918)" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 204, + "_postman_previewlanguage": "json", + "body": "{\n \"key\": \"\",\n \"value\": \"\",\n \"name\": \"\"\n}", + "code": 200, "cookie": [], - "header": [], - "name": "No Content", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], - "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", + "settings", + "organizations", ":orgId", - "v2", - "Users", - ":userId" + "settings", + ":settingKey" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The Webex organization id in Control Hub UUID or API orgId format.", "key": "orgId" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "The key of the setting.", + "key": "settingKey" } ] } }, - "status": "No Content" + "status": "OK" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", + "settings", + "organizations", ":orgId", - "v2", - "Users", - ":userId" + "settings", + ":settingKey" ], - "raw": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId", + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", "variable": [ { - "description": "Webex Identity assigned organization identifier for user's organization.", + "description": "The Webex organization id in Control Hub UUID or API orgId format.", "key": "orgId" }, { - "description": "Webex Identity assigned user identifier.", - "key": "userId" + "description": "The key of the setting.", + "key": "settingKey" } ] } }, - "status": "Unauthorized" - } - ] - }, - { - "name": "Get Me", - "request": { - "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- `identity:people_read`\n\n
\n\nThe API can be used by any user to retrieve user information using their own access token.\n\n
", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity", - "scim", - "v2", - "Users", - "me" - ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" - } - }, - "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": [ - "identity", - "scim", - "v2", - "Users", - "me" - ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" - } - }, - "status": "Method Not Allowed" + "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": { "header": [], "method": "GET", @@ -80296,24 +85045,34 @@ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - "v2", - "Users", - "me" + "settings", + "organizations", + ":orgId", + "settings", + ":settingKey" ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" + }, + { + "description": "The key of the setting.", + "key": "settingKey" + } + ] } }, - "status": "Unauthorized" + "status": "Unsupported Media Type" }, { "_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", @@ -80322,24 +85081,34 @@ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - "v2", - "Users", - "me" + "settings", + "organizations", + ":orgId", + "settings", + ":settingKey" ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" + }, + { + "description": "The key of the setting.", + "key": "settingKey" + } + ] } }, - "status": "Unsupported Media Type" + "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", @@ -80348,16 +85117,26 @@ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - "v2", - "Users", - "me" + "settings", + "organizations", + ":orgId", + "settings", + ":settingKey" ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" + }, + { + "description": "The key of the setting.", + "key": "settingKey" + } + ] } }, - "status": "Service Unavailable" + "status": "Not Found" }, { "_postman_previewlanguage": "text", @@ -80374,13 +85153,23 @@ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - "v2", - "Users", - "me" + "settings", + "organizations", + ":orgId", + "settings", + ":settingKey" ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" + }, + { + "description": "The key of the setting.", + "key": "settingKey" + } + ] } }, "status": "Internal Server Error" @@ -80388,10 +85177,10 @@ { "_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": { "header": [], "method": "GET", @@ -80400,24 +85189,34 @@ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - "v2", - "Users", - "me" + "settings", + "organizations", + ":orgId", + "settings", + ":settingKey" ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" + }, + { + "description": "The key of the setting.", + "key": "settingKey" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Gateway" }, { "_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", @@ -80426,24 +85225,34 @@ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - "v2", - "Users", - "me" + "settings", + "organizations", + ":orgId", + "settings", + ":settingKey" ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" + }, + { + "description": "The key of the setting.", + "key": "settingKey" + } + ] } }, - "status": "Conflict" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 504, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -80452,24 +85261,34 @@ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - "v2", - "Users", - "me" + "settings", + "organizations", + ":orgId", + "settings", + ":settingKey" ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" + }, + { + "description": "The key of the setting.", + "key": "settingKey" + } + ] } }, - "status": "Bad Request" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 503, "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": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -80478,24 +85297,34 @@ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - "v2", - "Users", - "me" + "settings", + "organizations", + ":orgId", + "settings", + ":settingKey" ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" + }, + { + "description": "The key of the setting.", + "key": "settingKey" + } + ] } }, - "status": "Too Many Requests" + "status": "Service Unavailable" }, { "_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": { "header": [], "method": "GET", @@ -80504,17 +85333,75 @@ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - "v2", - "Users", - "me" + "settings", + "organizations", + ":orgId", + "settings", + ":settingKey" ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" + }, + { + "description": "The key of the setting.", + "key": "settingKey" + } + ] } }, - "status": "Forbidden" + "status": "Too Many Requests" + } + ] + }, + { + "name": "Create or Update an Organization Setting", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" }, + "description": "This endpoint creates or updates the specified setting for the given organization; however, the 'name' of the setting cannot be modified. It is accessible with the scope 'identity:organizations_rw'.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "settings", + "organizations", + ":orgId", + "settings" + ], + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "text", "body": null, @@ -80523,20 +85410,40 @@ "header": [], "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 \"key\": \"\",\n \"value\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - "v2", - "Users", - "me" + "settings", + "organizations", + ":orgId", + "settings" ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" + } + ] } }, "status": "Precondition Required" @@ -80544,862 +85451,786 @@ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - "v2", - "Users", - "me" + "settings", + "organizations", + ":orgId", + "settings" ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" + } + ] } }, - "status": "Gateway Timeout" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 403, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", - "originalRequest": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity", - "scim", - "v2", - "Users", - "me" - ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" - } - }, - "status": "Gone" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"userName\": \"\",\n \"userType\": \"external_calling\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"active\": \"\",\n \"roles\": [\n {\n \"value\": \"\",\n \"type\": \"\",\n \"display\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\",\n \"display\": \"\"\n }\n ],\n \"name\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"middleName\": \"\",\n \"honorificPrefix\": \"\",\n \"honorificSuffix\": \"\"\n },\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"profileUrl\": \"\",\n \"title\": \"\",\n \"preferredLanguage\": \"\",\n \"locale\": \"\",\n \"externalId\": \"\",\n \"timezone\": \"\",\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"mobile\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\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 \"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 \"displayName\": \"\",\n \"$ref\": \"\"\n }\n },\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\": {\n \"accountStatus\": \"pending\",\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}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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 \"key\": \"\",\n \"value\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - "v2", - "Users", - "me" + "settings", + "organizations", + ":orgId", + "settings" ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" + } + ] } }, - "status": "OK" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 410, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "scim", - "v2", - "Users", - "me" + "settings", + "organizations", + ":orgId", + "settings" ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" + } + ] } }, - "status": "Bad Gateway" + "status": "Gone" }, { "_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", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity", - "scim", - "v2", - "Users", - "me" - ], - "raw": "{{baseUrl}}/identity/scim/v2/Users/me" - } - }, - "status": "Not Found" - } - ] - } - ], - "name": "SCIM 2 Users" - }, - { - "item": [ - { - "name": "List Security Audit Events", - "request": { - "description": "List Security Audit Events. This API currently returns user sign-in and sign-out data.\nTo call this API the `audit:events_read` scope must be selected for the Integration or Service App and authorized by a Full Admin.\n\nSeveral query parameters are available to filter the response.\n\nLong result sets will be split into multiple [pages](/docs/basics#pagination)\n\n**NOTE**: A maximum of one year of audit events can be returned per request.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "securityAudit", - "events" - ], - "query": [ - { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, - { - "description": "List events, by event categories.", - "key": "eventCategories", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" }, - { - "description": "List events, by event categories.", - "key": "eventCategories", - "value": "" + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "settings", + "organizations", + ":orgId", + "settings" + ], + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" + } + ] } - ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=&eventCategories=" - } - }, - "response": [ + }, + "status": "Service Unavailable" + }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"data\": {\n \"actorOrgName\": \"\",\n \"eventDescription\": \"\",\n \"actorName\": \"\",\n \"actorEmail\": \"\",\n \"actorUserAgent\": \"\",\n \"trackingId\": \"\",\n \"eventCategory\": \"\",\n \"actorIp\": \"\",\n \"actionText\": \"\"\n },\n \"created\": \"\",\n \"actorOrgId\": \"\",\n \"id\": \"\",\n \"actorId\": \"\"\n },\n {\n \"data\": {\n \"actorOrgName\": \"\",\n \"eventDescription\": \"\",\n \"actorName\": \"\",\n \"actorEmail\": \"\",\n \"actorUserAgent\": \"\",\n \"trackingId\": \"\",\n \"eventCategory\": \"\",\n \"actorIp\": \"\",\n \"actionText\": \"\"\n },\n \"created\": \"\",\n \"actorOrgId\": \"\",\n \"id\": \"\",\n \"actorId\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "description": { - "content": "", - "type": "text/plain" + "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" + } }, - "disabled": false, - "key": "link", - "value": "" + "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Content-Disposition", - "value": "" + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "settings", + "organizations", + ":orgId", + "settings" + ], + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ + { + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" + } + ] } - ], - "name": "OK", + }, + "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 \"key\": \"\",\n \"value\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "securityAudit", - "events" + "settings", + "organizations", + ":orgId", + "settings" ], - "query": [ - { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ { - "description": "List events, by event categories.", - "key": "eventCategories", - "value": "" + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" + ] } }, - "status": "OK" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "securityAudit", - "events" + "settings", + "organizations", + ":orgId", + "settings" ], - "query": [ - { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ { - "description": "List events, by event categories.", - "key": "eventCategories", - "value": "" + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" + ] } }, - "status": "Gateway Timeout" + "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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "securityAudit", - "events" + "settings", + "organizations", + ":orgId", + "settings" ], - "query": [ - { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ { - "description": "List events, by event categories.", - "key": "eventCategories", - "value": "" + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" + ] } }, - "status": "Not Found" + "status": "Bad Gateway" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "securityAudit", - "events" + "settings", + "organizations", + ":orgId", + "settings" ], - "query": [ - { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ { - "description": "List events, by event categories.", - "key": "eventCategories", - "value": "" + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" + ] } }, - "status": "Precondition Required" + "status": "Gateway Timeout" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "securityAudit", - "events" + "settings", + "organizations", + ":orgId", + "settings" ], - "query": [ - { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ { - "description": "List events, by event categories.", - "key": "eventCategories", - "value": "" + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Request" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "securityAudit", - "events" + "settings", + "organizations", + ":orgId", + "settings" ], - "query": [ - { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ { - "description": "List events, by event categories.", - "key": "eventCategories", - "value": "" + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" + ] } }, - "status": "Method Not Allowed" + "status": "Unsupported Media Type" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "securityAudit", - "events" + "settings", + "organizations", + ":orgId", + "settings" ], - "query": [ - { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ { - "description": "List events, by event categories.", - "key": "eventCategories", - "value": "" + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" + ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "securityAudit", - "events" + "settings", + "organizations", + ":orgId", + "settings" ], - "query": [ - { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ { - "description": "List events, by event categories.", - "key": "eventCategories", - "value": "" + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" + ] } }, - "status": "Bad Gateway" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 429, + "_postman_previewlanguage": "json", + "body": "{\n \"key\": \"\",\n \"value\": \"\",\n \"name\": \"\"\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": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "securityAudit", - "events" + "settings", + "organizations", + ":orgId", + "settings" ], - "query": [ - { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ { - "description": "List events, by event categories.", - "key": "eventCategories", - "value": "" + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" + ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_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 \"key\": \"\",\n \"value\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "securityAudit", - "events" + "settings", + "organizations", + ":orgId", + "settings" ], - "query": [ - { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, + "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "variable": [ { - "description": "List events, by event categories.", - "key": "eventCategories", - "value": "" + "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" + ] } }, - "status": "Service Unavailable" - }, + "status": "Not Found" + } + ] + } + ], + "name": "Settings" + }, + { + "item": [ + { + "name": "Retrieve all customer tags", + "request": { + "description": "Retrieves all tags which are being used by any customer organizations. Once a tag is unassigned from the last customer, it is automatically removed and is not returned by this API.\nThis API can be used by a partner full admin, a read-only partner, or an partner admin. \nThe `type` can have the value ORGANIZATION or SUBSCRIPTION. If not provided, the value is ORGANIZATION", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "partner", + "tags" + ], + "query": [ + { + "description": "List tags associated with an organization.", + "key": "type", + "value": "" + } + ], + "raw": "{{baseUrl}}/partner/tags?type=" + } + }, + "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 410, + "_postman_previewlanguage": "json", + "body": "[\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n]", + "code": 200, "cookie": [], - "header": [], - "name": "Gone: The requested resource is no longer available.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "securityAudit", - "events" + "partner", + "tags" ], "query": [ { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, - { - "description": "List events, by event categories.", - "key": "eventCategories", + "description": "List tags associated with an organization.", + "key": "type", "value": "" } ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" + "raw": "{{baseUrl}}/partner/tags?type=" } }, - "status": "Gone" + "status": "OK" }, { "_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": "GET", @@ -81408,54 +86239,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "securityAudit", - "events" + "partner", + "tags" ], "query": [ { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, - { - "description": "List events, by event categories.", - "key": "eventCategories", + "description": "List tags associated with an organization.", + "key": "type", "value": "" } ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" + "raw": "{{baseUrl}}/partner/tags?type=" } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_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", @@ -81464,54 +86269,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "securityAudit", - "events" + "partner", + "tags" ], "query": [ { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, - { - "description": "List events, by event categories.", - "key": "eventCategories", + "description": "List tags associated with an organization.", + "key": "type", "value": "" } ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" + "raw": "{{baseUrl}}/partner/tags?type=" } }, - "status": "Conflict" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 405, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -81520,54 +86299,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "securityAudit", - "events" + "partner", + "tags" ], "query": [ { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, - { - "description": "List events, by event categories.", - "key": "eventCategories", + "description": "List tags associated with an organization.", + "key": "type", "value": "" } ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" + "raw": "{{baseUrl}}/partner/tags?type=" } }, - "status": "Unauthorized" + "status": "Method Not Allowed" }, { "_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", @@ -81576,46 +86329,20 @@ "{{baseUrl}}" ], "path": [ - "admin", - "securityAudit", - "events" + "partner", + "tags" ], "query": [ { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, - { - "description": "List events, by event categories.", - "key": "eventCategories", + "description": "List tags associated with an organization.", + "key": "type", "value": "" } ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" + "raw": "{{baseUrl}}/partner/tags?type=" } }, - "status": "Unsupported Media Type" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", @@ -81632,99 +86359,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "securityAudit", - "events" + "partner", + "tags" ], "query": [ { - "description": "List events in this organization, by ID.", - "key": "orgId", - "value": "" - }, - { - "description": "List events which occurred after a specific date and time.", - "key": "startTime", - "value": "" - }, - { - "description": "List events which occurred before a specific date and time.", - "key": "endTime", - "value": "" - }, - { - "description": "List events performed by this person, by ID.", - "key": "actorId", - "value": "" - }, - { - "description": "Limit the maximum number of events in the response. The maximum value is `1000`.", - "key": "max", - "value": "100" - }, - { - "description": "List events, by event categories.", - "key": "eventCategories", + "description": "List tags associated with an organization.", + "key": "type", "value": "" } ], - "raw": "{{baseUrl}}/admin/securityAudit/events?orgId=&startTime=&endTime=&actorId=&max=100&eventCategories=" + "raw": "{{baseUrl}}/partner/tags?type=" } }, "status": "Bad Request" - } - ] - } - ], - "name": "Security Audit Events" - }, - { - "item": [ - { - "name": "Get an Organization Setting", - "request": { - "description": "This endpoint retrieves the specified setting for the given organization and is accessible with the scope 'identity:organizations_read'.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "settings", - "organizations", - ":orgId", - "settings", - ":settingKey" - ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", - "variable": [ - { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", - "key": "orgId", - "value": "" - }, - { - "description": "The key of the setting.", - "key": "settingKey", - "value": "" - } - ] - } - }, - "response": [ + }, { "_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", @@ -81733,34 +86389,28 @@ "{{baseUrl}}" ], "path": [ - "settings", - "organizations", - ":orgId", - "settings", - ":settingKey" + "partner", + "tags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", - "variable": [ - { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", - "key": "orgId" - }, + "query": [ { - "description": "The key of the setting.", - "key": "settingKey" + "description": "List tags associated with an organization.", + "key": "type", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags?type=" } }, - "status": "Precondition Required" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 404, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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", @@ -81769,34 +86419,28 @@ "{{baseUrl}}" ], "path": [ - "settings", - "organizations", - ":orgId", - "settings", - ":settingKey" + "partner", + "tags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", - "variable": [ - { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", - "key": "orgId" - }, + "query": [ { - "description": "The key of the setting.", - "key": "settingKey" + "description": "List tags associated with an organization.", + "key": "type", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags?type=" } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_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": "GET", @@ -81805,34 +86449,28 @@ "{{baseUrl}}" ], "path": [ - "settings", - "organizations", - ":orgId", - "settings", - ":settingKey" + "partner", + "tags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", - "variable": [ - { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", - "key": "orgId" - }, + "query": [ { - "description": "The key of the setting.", - "key": "settingKey" + "description": "List tags associated with an organization.", + "key": "type", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags?type=" } }, - "status": "Conflict" + "status": "Internal Server Error" }, { "_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": { "header": [], "method": "GET", @@ -81841,26 +86479,20 @@ "{{baseUrl}}" ], "path": [ - "settings", - "organizations", - ":orgId", - "settings", - ":settingKey" + "partner", + "tags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", - "variable": [ - { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", - "key": "orgId" - }, + "query": [ { - "description": "The key of the setting.", - "key": "settingKey" + "description": "List tags associated with an organization.", + "key": "type", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags?type=" } }, - "status": "Bad Request" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", @@ -81877,72 +86509,50 @@ "{{baseUrl}}" ], "path": [ - "settings", - "organizations", - ":orgId", - "settings", - ":settingKey" + "partner", + "tags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", - "variable": [ - { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", - "key": "orgId" - }, + "query": [ { - "description": "The key of the setting.", - "key": "settingKey" + "description": "List tags associated with an organization.", + "key": "type", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags?type=" } }, "status": "Locked (WebDAV) (RFC 4918)" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"key\": \"\",\n \"value\": \"\",\n \"name\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 504, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "settings", - "organizations", - ":orgId", - "settings", - ":settingKey" + "partner", + "tags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", - "variable": [ - { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", - "key": "orgId" - }, + "query": [ { - "description": "The key of the setting.", - "key": "settingKey" + "description": "List tags associated with an organization.", + "key": "type", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags?type=" } }, - "status": "OK" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -81959,23 +86569,17 @@ "{{baseUrl}}" ], "path": [ - "settings", - "organizations", - ":orgId", - "settings", - ":settingKey" + "partner", + "tags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", - "variable": [ - { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", - "key": "orgId" - }, + "query": [ { - "description": "The key of the setting.", - "key": "settingKey" + "description": "List tags associated with an organization.", + "key": "type", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags?type=" } }, "status": "Forbidden" @@ -81983,10 +86587,10 @@ { "_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": "GET", @@ -81995,34 +86599,28 @@ "{{baseUrl}}" ], "path": [ - "settings", - "organizations", - ":orgId", - "settings", - ":settingKey" + "partner", + "tags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", - "variable": [ - { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", - "key": "orgId" - }, + "query": [ { - "description": "The key of the setting.", - "key": "settingKey" + "description": "List tags associated with an organization.", + "key": "type", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags?type=" } }, - "status": "Unsupported Media Type" + "status": "Unauthorized" }, { "_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", @@ -82031,34 +86629,28 @@ "{{baseUrl}}" ], "path": [ - "settings", - "organizations", - ":orgId", - "settings", - ":settingKey" + "partner", + "tags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", - "variable": [ - { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", - "key": "orgId" - }, + "query": [ { - "description": "The key of the setting.", - "key": "settingKey" + "description": "List tags associated with an organization.", + "key": "type", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags?type=" } }, - "status": "Method Not Allowed" + "status": "Conflict" }, { "_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", @@ -82067,170 +86659,210 @@ "{{baseUrl}}" ], "path": [ - "settings", - "organizations", - ":orgId", - "settings", - ":settingKey" + "partner", + "tags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", - "variable": [ - { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", - "key": "orgId" - }, + "query": [ { - "description": "The key of the setting.", - "key": "settingKey" + "description": "List tags associated with an organization.", + "key": "type", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags?type=" } }, - "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": [ - "settings", - "organizations", - ":orgId", - "settings", - ":settingKey" - ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", - "variable": [ - { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", - "key": "orgId" - }, - { - "description": "The key of the setting.", - "key": "settingKey" - } - ] + "status": "Service Unavailable" + } + ] + }, + { + "name": "Create or Replace existing customer tags with the provided ones", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } }, - "status": "Internal Server Error" + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" }, + "description": "Assign or replace tag(s) which for a customer organization. If the tag doesn't already exist, a new one is created and assigned to the customer automatically.\nThis API can be used by partner full admins and partner admins. \nEach tag has a character limit of 25. Currently, there is a limit of 5 tags per organization when creating tags. To remove all the tags, pass an empty array.\nSpecify the customer organization ID in the `orgId` parameter in the URI.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "partner", + "tags", + "organizations", + ":orgId", + "assignTags" + ], + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", + "variable": [ + { + "description": "The unique identifier for the customer organization.", + "key": "orgId", + "value": "" + } + ] + } + }, + "response": [ { "_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 \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", ":orgId", - "settings", - ":settingKey" + "assignTags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "The unique identifier for the customer organization.", "key": "orgId" - }, - { - "description": "The key of the setting.", - "key": "settingKey" } ] } }, - "status": "Bad Gateway" + "status": "Bad Request" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", ":orgId", - "settings", - ":settingKey" + "assignTags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "The unique identifier for the customer organization.", "key": "orgId" - }, - { - "description": "The key of the setting.", - "key": "settingKey" } ] } }, - "status": "Gone" + "status": "Forbidden" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", ":orgId", - "settings", - ":settingKey" + "assignTags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "The unique identifier for the customer organization.", "key": "orgId" - }, - { - "description": "The key of the setting.", - "key": "settingKey" } ] } }, - "status": "Gateway Timeout" + "status": "Not Found" }, { "_postman_previewlanguage": "text", @@ -82240,28 +86872,39 @@ "header": [], "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 \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", ":orgId", - "settings", - ":settingKey" + "assignTags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "The unique identifier for the customer organization.", "key": "orgId" - }, - { - "description": "The key of the setting.", - "key": "settingKey" } ] } @@ -82271,94 +86914,57 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 423, "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": "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 \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", ":orgId", - "settings", - ":settingKey" + "assignTags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "The unique identifier for the customer organization.", "key": "orgId" - }, - { - "description": "The key of the setting.", - "key": "settingKey" } ] } }, - "status": "Too Many Requests" - } - ] - }, - { - "name": "Create or Update an Organization Setting", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + "status": "Locked (WebDAV) (RFC 4918)" }, - "description": "This endpoint creates or updates the specified setting for the given organization; however, the 'name' of the setting cannot be modified. It is accessible with the scope 'identity:organizations_rw'.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "settings", - "organizations", - ":orgId", - "settings" - ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", - "variable": [ - { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", - "key": "orgId", - "value": "" - } - ] - } - }, - "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 409, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "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", @@ -82368,7 +86974,7 @@ "language": "json" } }, - "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82382,29 +86988,30 @@ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", ":orgId", - "settings" + "assignTags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "The unique identifier for the customer organization.", "key": "orgId" } ] } }, - "status": "Precondition Required" + "status": "Conflict" }, { "_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": { "body": { "mode": "raw", @@ -82414,7 +87021,7 @@ "language": "json" } }, - "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82428,29 +87035,35 @@ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", ":orgId", - "settings" + "assignTags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "The unique identifier for the customer organization.", "key": "orgId" } ] } }, - "status": "Conflict" + "status": "Gone" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 403, + "_postman_previewlanguage": "json", + "body": "[\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\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": { "body": { "mode": "raw", @@ -82460,12 +87073,16 @@ "language": "json" } }, - "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -82474,29 +87091,30 @@ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", ":orgId", - "settings" + "assignTags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "The unique identifier for the customer organization.", "key": "orgId" } ] } }, - "status": "Forbidden" + "status": "OK" }, { "_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", @@ -82506,7 +87124,7 @@ "language": "json" } }, - "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82520,29 +87138,30 @@ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", ":orgId", - "settings" + "assignTags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "The unique identifier for the customer organization.", "key": "orgId" } ] } }, - "status": "Gone" + "status": "Method Not Allowed" }, { "_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", @@ -82552,7 +87171,7 @@ "language": "json" } }, - "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82566,29 +87185,30 @@ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", ":orgId", - "settings" + "assignTags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "The unique identifier for the customer organization.", "key": "orgId" } ] } }, - "status": "Service Unavailable" + "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": { "body": { "mode": "raw", @@ -82598,7 +87218,7 @@ "language": "json" } }, - "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82612,29 +87232,30 @@ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", ":orgId", - "settings" + "assignTags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "The unique identifier for the customer organization.", "key": "orgId" } ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_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", @@ -82644,7 +87265,7 @@ "language": "json" } }, - "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82658,29 +87279,30 @@ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", ":orgId", - "settings" + "assignTags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "The unique identifier for the customer organization.", "key": "orgId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 401, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "body": { "mode": "raw", @@ -82690,7 +87312,7 @@ "language": "json" } }, - "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82704,29 +87326,30 @@ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", ":orgId", - "settings" + "assignTags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "The unique identifier for the customer organization.", "key": "orgId" } ] } }, - "status": "Method Not Allowed" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 428, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "body": { "mode": "raw", @@ -82736,7 +87359,7 @@ "language": "json" } }, - "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82750,21 +87373,22 @@ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", ":orgId", - "settings" + "assignTags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "The unique identifier for the customer organization.", "key": "orgId" } ] } }, - "status": "Bad Gateway" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", @@ -82782,7 +87406,7 @@ "language": "json" } }, - "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82796,15 +87420,16 @@ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", ":orgId", - "settings" + "assignTags" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "The unique identifier for the customer organization.", "key": "orgId" } ] @@ -82815,10 +87440,10 @@ { "_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": { "body": { "mode": "raw", @@ -82828,7 +87453,7 @@ "language": "json" } }, - "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82842,317 +87467,293 @@ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", ":orgId", - "settings" + "assignTags" + ], + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", + "variable": [ + { + "description": "The unique identifier for the customer organization.", + "key": "orgId" + } + ] + } + }, + "status": "Internal Server Error" + } + ] + }, + { + "name": "Get customer organization's tags", + "request": { + "description": "Retrieve tags associated with a customer organization based on the `orgId` provided.\nThis API can be used by a partner full admin, a read-only partner, or an partner admin. \nSpecify the customer orgId in the `orgId` parameter in the URI.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "partner", + "tags", + "organizations", + ":orgId" + ], + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "variable": [ + { + "description": "Fetch all customers and associated tags for the customer.", + "key": "orgId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"orgName\": \"\",\n \"orgId\": \"\",\n \"tags\": [\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": [ + "partner", + "tags", + "organizations", + ":orgId" + ], + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "variable": [ + { + "description": "Fetch all customers and associated tags for the customer.", + "key": "orgId" + } + ] + } + }, + "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": [ + "partner", + "tags", + "organizations", + ":orgId" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "Fetch all customers and associated tags for the customer.", "key": "orgId" } ] } }, - "status": "Bad Request" + "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", - ":orgId", - "settings" + ":orgId" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "Fetch all customers and associated tags for the customer.", "key": "orgId" } ] } }, - "status": "Unsupported Media Type" + "status": "Not Found" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", - ":orgId", - "settings" + ":orgId" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "Fetch all customers and associated tags for the customer.", "key": "orgId" } ] } }, - "status": "Unauthorized" + "status": "Precondition Required" }, { "_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 \"key\": \"\",\n \"value\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", - ":orgId", - "settings" + ":orgId" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "Fetch all customers and associated tags for the customer.", "key": "orgId" } ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"key\": \"\",\n \"value\": \"\",\n \"name\": \"\"\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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", - ":orgId", - "settings" + ":orgId" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "Fetch all customers and associated tags for the customer.", "key": "orgId" } ] } }, - "status": "OK" + "status": "Bad Request" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"key\": \"\",\n \"value\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "settings", + "partner", + "tags", "organizations", - ":orgId", - "settings" + ":orgId" ], - "raw": "{{baseUrl}}/settings/organizations/:orgId/settings", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", "variable": [ { - "description": "The Webex organization id in Control Hub UUID or API orgId format.", + "description": "Fetch all customers and associated tags for the customer.", "key": "orgId" } ] } }, - "status": "Not Found" - } - ] - } - ], - "name": "Settings" - }, - { - "item": [ - { - "name": "Retrieve all customer tags", - "request": { - "description": "Retrieves all tags which are being used by any customer organizations. Once a tag is unassigned from the last customer, it is automatically removed and is not returned by this API.\nThis API can be used by a partner full admin, a read-only partner, or an partner admin. \nThe `type` can have the value ORGANIZATION or SUBSCRIPTION. If not provided, the value is ORGANIZATION", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "partner", - "tags" - ], - "query": [ - { - "description": "List tags associated with an organization.", - "key": "type", - "value": "" - } - ], - "raw": "{{baseUrl}}/partner/tags?type=" - } - }, - "response": [ + "status": "Unauthorized" + }, { - "_postman_previewlanguage": "json", - "body": "[\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n]", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 429, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -83160,27 +87761,28 @@ ], "path": [ "partner", - "tags" + "tags", + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "variable": [ { - "description": "List tags associated with an organization.", - "key": "type", - "value": "" + "description": "Fetch all customers and associated tags for the customer.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/tags?type=" + ] } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 503, "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": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -83190,27 +87792,28 @@ ], "path": [ "partner", - "tags" + "tags", + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "variable": [ { - "description": "List tags associated with an organization.", - "key": "type", - "value": "" + "description": "Fetch all customers and associated tags for the customer.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/tags?type=" + ] } }, - "status": "Too Many Requests" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 423, "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": "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", @@ -83220,27 +87823,28 @@ ], "path": [ "partner", - "tags" + "tags", + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "variable": [ { - "description": "List tags associated with an organization.", - "key": "type", - "value": "" + "description": "Fetch all customers and associated tags for the customer.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/tags?type=" + ] } }, - "status": "Unsupported Media Type" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", @@ -83250,27 +87854,28 @@ ], "path": [ "partner", - "tags" + "tags", + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "variable": [ { - "description": "List tags associated with an organization.", - "key": "type", - "value": "" + "description": "Fetch all customers and associated tags for the customer.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/tags?type=" + ] } }, - "status": "Method Not Allowed" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 409, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "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", @@ -83280,27 +87885,28 @@ ], "path": [ "partner", - "tags" + "tags", + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "variable": [ { - "description": "List tags associated with an organization.", - "key": "type", - "value": "" + "description": "Fetch all customers and associated tags for the customer.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/tags?type=" + ] } }, - "status": "Precondition Required" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 415, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -83310,19 +87916,20 @@ ], "path": [ "partner", - "tags" + "tags", + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "variable": [ { - "description": "List tags associated with an organization.", - "key": "type", - "value": "" + "description": "Fetch all customers and associated tags for the customer.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/tags?type=" + ] } }, - "status": "Bad Request" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", @@ -83340,16 +87947,17 @@ ], "path": [ "partner", - "tags" + "tags", + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "variable": [ { - "description": "List tags associated with an organization.", - "key": "type", - "value": "" + "description": "Fetch all customers and associated tags for the customer.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/tags?type=" + ] } }, "status": "Gone" @@ -83357,10 +87965,10 @@ { "_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", @@ -83370,27 +87978,28 @@ ], "path": [ "partner", - "tags" + "tags", + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "variable": [ { - "description": "List tags associated with an organization.", - "key": "type", - "value": "" + "description": "Fetch all customers and associated tags for the customer.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/tags?type=" + ] } }, - "status": "Not Found" + "status": "Method Not Allowed" }, { "_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", @@ -83400,27 +88009,66 @@ ], "path": [ "partner", - "tags" + "tags", + "organizations", + ":orgId" ], - "query": [ + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "variable": [ { - "description": "List tags associated with an organization.", - "key": "type", - "value": "" + "description": "Fetch all customers and associated tags for the customer.", + "key": "orgId" } - ], - "raw": "{{baseUrl}}/partner/tags?type=" + ] } }, - "status": "Internal Server Error" - }, + "status": "Gateway Timeout" + } + ] + }, + { + "name": "Fetch all customers for a given set of tags", + "request": { + "description": "For a set of tags, retrieve all customer organizations that match any one of the tags.\nThis API can be used by a partner full admin, a read-only partner, or an partner admin.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "partner", + "tags", + "organizations" + ], + "query": [ + { + "description": "A comma separated list of tags to filter by.", + "key": "tags", + "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" + } + ], + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + } + }, + "response": [ { "_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", @@ -83430,27 +88078,33 @@ ], "path": [ "partner", - "tags" + "tags", + "organizations" ], "query": [ { - "description": "List tags associated with an organization.", - "key": "type", + "description": "A comma separated list of tags to filter by.", + "key": "tags", "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags?type=" + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" } }, - "status": "Bad Gateway" + "status": "Too Many Requests" }, { "_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": "GET", @@ -83460,27 +88114,33 @@ ], "path": [ "partner", - "tags" + "tags", + "organizations" ], "query": [ { - "description": "List tags associated with an organization.", - "key": "type", + "description": "A comma separated list of tags to filter by.", + "key": "tags", "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags?type=" + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Conflict" }, { "_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": { "header": [], "method": "GET", @@ -83490,27 +88150,33 @@ ], "path": [ "partner", - "tags" + "tags", + "organizations" ], "query": [ { - "description": "List tags associated with an organization.", - "key": "type", + "description": "A comma separated list of tags to filter by.", + "key": "tags", "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags?type=" + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" } }, - "status": "Gateway Timeout" + "status": "Method Not Allowed" }, { "_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", @@ -83520,27 +88186,33 @@ ], "path": [ "partner", - "tags" + "tags", + "organizations" ], "query": [ { - "description": "List tags associated with an organization.", - "key": "type", + "description": "A comma separated list of tags to filter by.", + "key": "tags", "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags?type=" + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_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": "GET", @@ -83550,27 +88222,33 @@ ], "path": [ "partner", - "tags" + "tags", + "organizations" ], "query": [ { - "description": "List tags associated with an organization.", - "key": "type", + "description": "A comma separated list of tags to filter by.", + "key": "tags", "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags?type=" + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" } }, - "status": "Unauthorized" + "status": "Gateway Timeout" }, { "_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": "GET", @@ -83580,27 +88258,33 @@ ], "path": [ "partner", - "tags" + "tags", + "organizations" ], "query": [ { - "description": "List tags associated with an organization.", - "key": "type", + "description": "A comma separated list of tags to filter by.", + "key": "tags", "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags?type=" + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" } }, - "status": "Conflict" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 403, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], "method": "GET", @@ -83610,94 +88294,46 @@ ], "path": [ "partner", - "tags" + "tags", + "organizations" ], "query": [ { - "description": "List tags associated with an organization.", - "key": "type", + "description": "A comma separated list of tags to filter by.", + "key": "tags", "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags?type=" - } - }, - "status": "Service Unavailable" - } - ] - }, - { - "name": "Create or Replace existing customer tags with the provided ones", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" } }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" + "status": "Forbidden" }, - "description": "Assign or replace tag(s) which for a customer organization. If the tag doesn't already exist, a new one is created and assigned to the customer automatically.\nThis API can be used by partner full admins and partner admins. \nEach tag has a character limit of 25. Currently, there is a limit of 5 tags per organization when creating tags. To remove all the tags, pass an empty array.\nSpecify the customer organization ID in the `orgId` parameter in the URI.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "assignTags" - ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", - "variable": [ - { - "description": "The unique identifier for the customer organization.", - "key": "orgId", - "value": "" - } - ] - } - }, - "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 400, + "_postman_previewlanguage": "json", + "body": "[\n {\n \"orgName\": \"\",\n \"orgId\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"orgName\": \"\",\n \"orgId\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n]", + "code": 200, "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": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -83705,46 +88341,35 @@ "path": [ "partner", "tags", - "organizations", - ":orgId", - "assignTags" + "organizations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", - "variable": [ + "query": [ { - "description": "The unique identifier for the customer organization.", - "key": "orgId" + "description": "A comma separated list of tags to filter by.", + "key": "tags", + "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" } }, - "status": "Bad Request" + "status": "OK" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -83752,46 +88377,35 @@ "path": [ "partner", "tags", - "organizations", - ":orgId", - "assignTags" + "organizations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", - "variable": [ + "query": [ { - "description": "The unique identifier for the customer organization.", - "key": "orgId" + "description": "A comma separated list of tags to filter by.", + "key": "tags", + "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" } }, - "status": "Forbidden" + "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 \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -83799,46 +88413,35 @@ "path": [ "partner", "tags", - "organizations", - ":orgId", - "assignTags" + "organizations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", - "variable": [ + "query": [ { - "description": "The unique identifier for the customer organization.", - "key": "orgId" + "description": "A comma separated list of tags to filter by.", + "key": "tags", + "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" } }, - "status": "Not Found" + "status": "Precondition Required" }, { "_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 \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -83846,46 +88449,35 @@ "path": [ "partner", "tags", - "organizations", - ":orgId", - "assignTags" + "organizations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", - "variable": [ + "query": [ { - "description": "The unique identifier for the customer organization.", - "key": "orgId" + "description": "A comma separated list of tags to filter by.", + "key": "tags", + "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" } }, - "status": "Service Unavailable" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 415, "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": "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 \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -83893,46 +88485,35 @@ "path": [ "partner", "tags", - "organizations", - ":orgId", - "assignTags" + "organizations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", - "variable": [ + "query": [ { - "description": "The unique identifier for the customer organization.", - "key": "orgId" + "description": "A comma separated list of tags to filter by.", + "key": "tags", + "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unsupported Media Type" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -83940,46 +88521,35 @@ "path": [ "partner", "tags", - "organizations", - ":orgId", - "assignTags" + "organizations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", - "variable": [ + "query": [ { - "description": "The unique identifier for the customer organization.", - "key": "orgId" + "description": "A comma separated list of tags to filter by.", + "key": "tags", + "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" } }, - "status": "Conflict" + "status": "Bad Gateway" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -83987,55 +88557,35 @@ "path": [ "partner", "tags", - "organizations", - ":orgId", - "assignTags" + "organizations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", - "variable": [ + "query": [ { - "description": "The unique identifier for the customer organization.", - "key": "orgId" + "description": "A comma separated list of tags to filter by.", + "key": "tags", + "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" } }, - "status": "Gone" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "json", - "body": "[\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n]", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 400, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "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}}" @@ -84043,46 +88593,35 @@ "path": [ "partner", "tags", - "organizations", - ":orgId", - "assignTags" + "organizations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", - "variable": [ + "query": [ { - "description": "The unique identifier for the customer organization.", - "key": "orgId" + "description": "A comma separated list of tags to filter by.", + "key": "tags", + "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" } }, - "status": "OK" + "status": "Bad Request" }, { "_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 \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -84090,28 +88629,88 @@ "path": [ "partner", "tags", - "organizations", - ":orgId", - "assignTags" + "organizations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", - "variable": [ + "query": [ { - "description": "The unique identifier for the customer organization.", - "key": "orgId" + "description": "A comma separated list of tags to filter by.", + "key": "tags", + "value": "" + }, + { + "description": "Value must be between 1 and 100, inclusive.", + "key": "max", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" } }, - "status": "Method Not Allowed" + "status": "Gone" + } + ] + }, + { + "name": "Create or Replace existing subscription tags with the provided ones", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" }, + "description": "Assign or replace tags specific to each subscription for an organization. Each organization may have one or more subscriptions.\nThis API can be used by partner full admins and partner admins. \nCurrently there is a limit of 5 tags per subscription when creating tags. To remove all the tags, pass an empty array.\nSpecify the customer organization ID in the `orgId` parameter in the URI and subscription ID in `subscriptionId` parameter", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "partner", + "tags", + "organizations", + ":orgId", + "subscriptions", + ":subscriptionId", + "assignTags" + ], + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "variable": [ + { + "description": "The unique identifier for the customer organization.", + "key": "orgId", + "value": "" + }, + { + "description": "The unique identifier for the subscription.", + "key": "subscriptionId", + "value": "" + } + ] + } + }, + "response": [ { "_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": "raw", @@ -84139,26 +88738,32 @@ "tags", "organizations", ":orgId", + "subscriptions", + ":subscriptionId", "assignTags" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", "variable": [ { "description": "The unique identifier for the customer organization.", "key": "orgId" + }, + { + "description": "The unique identifier for the subscription.", + "key": "subscriptionId" } ] } }, - "status": "Unsupported Media Type" + "status": "Not Found" }, { "_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", @@ -84186,26 +88791,32 @@ "tags", "organizations", ":orgId", + "subscriptions", + ":subscriptionId", "assignTags" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", "variable": [ { "description": "The unique identifier for the customer organization.", "key": "orgId" + }, + { + "description": "The unique identifier for the subscription.", + "key": "subscriptionId" } ] } }, - "status": "Too Many Requests" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 428, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "body": { "mode": "raw", @@ -84233,26 +88844,32 @@ "tags", "organizations", ":orgId", + "subscriptions", + ":subscriptionId", "assignTags" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", "variable": [ { "description": "The unique identifier for the customer organization.", "key": "orgId" + }, + { + "description": "The unique identifier for the subscription.", + "key": "subscriptionId" } ] } }, - "status": "Bad Gateway" + "status": "Precondition Required" }, { "_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", @@ -84280,26 +88897,32 @@ "tags", "organizations", ":orgId", + "subscriptions", + ":subscriptionId", "assignTags" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", "variable": [ { "description": "The unique identifier for the customer organization.", "key": "orgId" + }, + { + "description": "The unique identifier for the subscription.", + "key": "subscriptionId" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 400, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "body": { "mode": "raw", @@ -84327,26 +88950,32 @@ "tags", "organizations", ":orgId", + "subscriptions", + ":subscriptionId", "assignTags" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", "variable": [ { "description": "The unique identifier for the customer organization.", "key": "orgId" + }, + { + "description": "The unique identifier for the subscription.", + "key": "subscriptionId" } ] } }, - "status": "Precondition Required" + "status": "Bad Request" }, { "_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", @@ -84374,26 +89003,32 @@ "tags", "organizations", ":orgId", + "subscriptions", + ":subscriptionId", "assignTags" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", "variable": [ { "description": "The unique identifier for the customer organization.", "key": "orgId" + }, + { + "description": "The unique identifier for the subscription.", + "key": "subscriptionId" } ] } }, - "status": "Gateway Timeout" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 401, "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": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "body": { "mode": "raw", @@ -84421,56 +89056,28 @@ "tags", "organizations", ":orgId", + "subscriptions", + ":subscriptionId", "assignTags" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", "variable": [ { "description": "The unique identifier for the customer organization.", "key": "orgId" + }, + { + "description": "The unique identifier for the subscription.", + "key": "subscriptionId" } ] } }, - "status": "Internal Server Error" - } - ] - }, - { - "name": "Get customer organization's tags", - "request": { - "description": "Retrieve tags associated with a customer organization based on the `orgId` provided.\nThis API can be used by a partner full admin, a read-only partner, or an partner admin. \nSpecify the customer orgId in the `orgId` parameter in the URI.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "partner", - "tags", - "organizations", - ":orgId" - ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", - "variable": [ - { - "description": "Fetch all customers and associated tags for the customer.", - "key": "orgId", - "value": "" - } - ] - } - }, - "response": [ + "status": "Unauthorized" + }, { "_postman_previewlanguage": "json", - "body": "{\n \"orgName\": \"\",\n \"orgId\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", + "body": "[\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -84481,199 +89088,27 @@ ], "name": "OK", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "partner", - "tags", - "organizations", - ":orgId" - ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", - "variable": [ - { - "description": "Fetch all customers and associated tags for the customer.", - "key": "orgId" - } - ] - } - }, - "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": [ - "partner", - "tags", - "organizations", - ":orgId" - ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", - "variable": [ - { - "description": "Fetch all customers and associated tags for the customer.", - "key": "orgId" - } - ] - } - }, - "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": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "partner", - "tags", - "organizations", - ":orgId" - ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", - "variable": [ - { - "description": "Fetch all customers and associated tags for the customer.", - "key": "orgId" - } - ] - } - }, - "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": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "partner", - "tags", - "organizations", - ":orgId" - ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", - "variable": [ - { - "description": "Fetch all customers and associated tags for the customer.", - "key": "orgId" - } - ] - } - }, - "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": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "partner", - "tags", - "organizations", - ":orgId" - ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", - "variable": [ - { - "description": "Fetch all customers and associated tags for the customer.", - "key": "orgId" - } - ] - } - }, - "status": "Internal Server Error" - }, - { - "_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": [ - "partner", - "tags", - "organizations", - ":orgId" - ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", - "variable": [ - { - "description": "Fetch all customers and associated tags for the customer.", - "key": "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", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -84682,60 +89117,51 @@ "partner", "tags", "organizations", - ":orgId" + ":orgId", + "subscriptions", + ":subscriptionId", + "assignTags" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", "variable": [ { - "description": "Fetch all customers and associated tags for the customer.", + "description": "The unique identifier for the customer organization.", "key": "orgId" - } - ] - } - }, - "status": "Unauthorized" - }, - { - "_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": [ - "partner", - "tags", - "organizations", - ":orgId" - ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", - "variable": [ + }, { - "description": "Fetch all customers and associated tags for the customer.", - "key": "orgId" + "description": "The unique identifier for the subscription.", + "key": "subscriptionId" } ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 409, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. 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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -84744,29 +89170,51 @@ "partner", "tags", "organizations", - ":orgId" + ":orgId", + "subscriptions", + ":subscriptionId", + "assignTags" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", "variable": [ { - "description": "Fetch all customers and associated tags for the customer.", + "description": "The unique identifier for the customer organization.", "key": "orgId" + }, + { + "description": "The unique identifier for the subscription.", + "key": "subscriptionId" } ] } }, - "status": "Service Unavailable" + "status": "Conflict" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -84775,29 +89223,51 @@ "partner", "tags", "organizations", - ":orgId" + ":orgId", + "subscriptions", + ":subscriptionId", + "assignTags" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", "variable": [ { - "description": "Fetch all customers and associated tags for the customer.", + "description": "The unique identifier for the customer organization.", "key": "orgId" + }, + { + "description": "The unique identifier for the subscription.", + "key": "subscriptionId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Gateway" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -84806,29 +89276,51 @@ "partner", "tags", "organizations", - ":orgId" + ":orgId", + "subscriptions", + ":subscriptionId", + "assignTags" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", "variable": [ { - "description": "Fetch all customers and associated tags for the customer.", + "description": "The unique identifier for the customer organization.", "key": "orgId" + }, + { + "description": "The unique identifier for the subscription.", + "key": "subscriptionId" } ] } }, - "status": "Bad Gateway" + "status": "Gateway Timeout" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -84837,29 +89329,51 @@ "partner", "tags", "organizations", - ":orgId" + ":orgId", + "subscriptions", + ":subscriptionId", + "assignTags" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", "variable": [ { - "description": "Fetch all customers and associated tags for the customer.", + "description": "The unique identifier for the customer organization.", "key": "orgId" + }, + { + "description": "The unique identifier for the subscription.", + "key": "subscriptionId" } ] } }, - "status": "Conflict" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -84868,29 +89382,51 @@ "partner", "tags", "organizations", - ":orgId" + ":orgId", + "subscriptions", + ":subscriptionId", + "assignTags" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", "variable": [ { - "description": "Fetch all customers and associated tags for the customer.", + "description": "The unique identifier for the customer organization.", "key": "orgId" + }, + { + "description": "The unique identifier for the subscription.", + "key": "subscriptionId" } ] } }, - "status": "Unsupported Media Type" + "status": "Forbidden" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -84899,29 +89435,51 @@ "partner", "tags", "organizations", - ":orgId" + ":orgId", + "subscriptions", + ":subscriptionId", + "assignTags" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", "variable": [ { - "description": "Fetch all customers and associated tags for the customer.", + "description": "The unique identifier for the customer organization.", "key": "orgId" + }, + { + "description": "The unique identifier for the subscription.", + "key": "subscriptionId" } ] } }, - "status": "Gone" + "status": "Method Not Allowed" }, { "_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 \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -84930,29 +89488,51 @@ "partner", "tags", "organizations", - ":orgId" + ":orgId", + "subscriptions", + ":subscriptionId", + "assignTags" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", "variable": [ { - "description": "Fetch all customers and associated tags for the customer.", + "description": "The unique identifier for the customer organization.", "key": "orgId" + }, + { + "description": "The unique identifier for the subscription.", + "key": "subscriptionId" } ] } }, - "status": "Method Not Allowed" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 429, "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": "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 \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -84961,25 +89541,32 @@ "partner", "tags", "organizations", - ":orgId" + ":orgId", + "subscriptions", + ":subscriptionId", + "assignTags" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", "variable": [ { - "description": "Fetch all customers and associated tags for the customer.", + "description": "The unique identifier for the customer organization.", "key": "orgId" + }, + { + "description": "The unique identifier for the subscription.", + "key": "subscriptionId" } ] } }, - "status": "Gateway Timeout" + "status": "Too Many Requests" } ] }, { - "name": "Fetch all customers for a given set of tags", + "name": "Subscription List on a given tag name or a set of tags", "request": { - "description": "For a set of tags, retrieve all customer organizations that match any one of the tags.\nThis API can be used by a partner full admin, a read-only partner, or an partner admin.", + "description": "For a partner organization fetch all it's subscriptions with their tag list for a given tag names.\nThis API can be used by partner full admins, partner admins and admin read-only partners.", "header": [ { "key": "Accept", @@ -84994,7 +89581,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85008,17 +89595,17 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, "response": [ { "_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": { "header": [], "method": "GET", @@ -85029,7 +89616,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85043,18 +89630,18 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, - "status": "Too Many Requests" + "status": "Gone" }, { "_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": "GET", @@ -85065,7 +89652,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85079,18 +89666,18 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, - "status": "Conflict" + "status": "Internal Server Error" }, { "_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", @@ -85101,7 +89688,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85115,18 +89702,18 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, - "status": "Method Not Allowed" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 404, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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", @@ -85137,7 +89724,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85151,18 +89738,18 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_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": "GET", @@ -85173,7 +89760,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85187,20 +89774,30 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, - "status": "Gateway Timeout" + "status": "Precondition Required" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 404, + "_postman_previewlanguage": "json", + "body": "[\n {\n \"orgName\": \"\",\n \"orgId\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"subscriptionId\": \"\",\n \"trial\": \"\"\n },\n {\n \"orgName\": \"\",\n \"orgId\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"subscriptionId\": \"\",\n \"trial\": \"\"\n }\n]", + "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": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ @@ -85209,7 +89806,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85223,10 +89820,10 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, - "status": "Not Found" + "status": "OK" }, { "_postman_previewlanguage": "text", @@ -85245,7 +89842,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85259,30 +89856,20 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "[\n {\n \"orgName\": \"\",\n \"orgId\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"orgName\": \"\",\n \"orgId\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n]", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -85291,7 +89878,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85305,18 +89892,18 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, - "status": "OK" + "status": "Unauthorized" }, { "_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": "GET", @@ -85327,7 +89914,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85341,18 +89928,18 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_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", @@ -85363,7 +89950,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85377,18 +89964,18 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, - "status": "Precondition Required" + "status": "Gateway Timeout" }, { "_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": { "header": [], "method": "GET", @@ -85399,7 +89986,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85413,18 +90000,18 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 423, "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": "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", @@ -85435,7 +90022,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85449,18 +90036,18 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, - "status": "Unsupported Media Type" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { "header": [], "method": "GET", @@ -85471,7 +90058,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85485,18 +90072,18 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, - "status": "Bad Gateway" + "status": "Service Unavailable" }, { "_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", @@ -85507,7 +90094,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85521,18 +90108,18 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, - "status": "Service Unavailable" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 409, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -85543,7 +90130,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85557,18 +90144,18 @@ "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, - "status": "Bad Request" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 415, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "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", @@ -85579,7 +90166,7 @@ "path": [ "partner", "tags", - "organizations" + "subscriptions" ], "query": [ { @@ -85592,39 +90179,25 @@ "key": "max", "value": "" } - ], - "raw": "{{baseUrl}}/partner/tags/organizations?tags=&max=" - } - }, - "status": "Gone" - } - ] - }, - { - "name": "Create or Replace existing subscription tags with the provided ones", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + ], + "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" } }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "description": "Assign or replace tags specific to each subscription for an organization. Each organization may have one or more subscriptions.\nThis API can be used by partner full admins and partner admins. \nCurrently there is a limit of 5 tags per subscription when creating tags. To remove all the tags, pass an empty array.\nSpecify the customer organization ID in the `orgId` parameter in the URI and subscription ID in `subscriptionId` parameter", + "status": "Unsupported Media Type" + } + ] + }, + { + "name": "Fetch a Subscription", + "request": { + "description": "For a given partner org, customer org and external subscription id, fetch subscription details with its associated tags.\nThis API can be used by partner full admins, partner admins and admin read-only partners.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -85635,10 +90208,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -85657,28 +90229,13 @@ { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -85689,10 +90246,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -85705,33 +90261,18 @@ ] } }, - "status": "Not Found" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 400, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "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 \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -85742,10 +90283,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -85758,33 +90298,28 @@ ] } }, - "status": "Gone" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 428, + "_postman_previewlanguage": "json", + "body": "{\n \"orgName\": \"\",\n \"orgId\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"subscriptionId\": \"\",\n \"trial\": \"\"\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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -85795,10 +90330,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -85811,33 +90345,18 @@ ] } }, - "status": "Precondition Required" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 401, "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": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -85848,10 +90367,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -85864,33 +90382,18 @@ ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 410, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -85901,10 +90404,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -85917,33 +90419,18 @@ ] } }, - "status": "Bad Request" + "status": "Gone" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -85954,10 +90441,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -85970,33 +90456,18 @@ ] } }, - "status": "Unsupported Media Type" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 429, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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 \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -86007,10 +90478,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -86023,42 +90493,18 @@ ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "[\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\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 \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -86069,10 +90515,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -86085,33 +90530,18 @@ ] } }, - "status": "OK" + "status": "Method Not Allowed" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -86122,10 +90552,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -86138,33 +90567,18 @@ ] } }, - "status": "Conflict" + "status": "Service Unavailable" }, { "_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 \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -86175,10 +90589,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -86191,7 +90604,7 @@ ] } }, - "status": "Bad Gateway" + "status": "Not Found" }, { "_postman_previewlanguage": "text", @@ -86201,23 +90614,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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -86228,10 +90626,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -86249,28 +90646,13 @@ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -86281,10 +90663,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -86297,33 +90678,18 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Gateway" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -86334,10 +90700,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -86350,33 +90715,18 @@ ] } }, - "status": "Forbidden" + "status": "Unsupported Media Type" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -86387,10 +90737,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -86403,33 +90752,18 @@ ] } }, - "status": "Method Not Allowed" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 409, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. 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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -86440,10 +90774,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -86456,33 +90789,18 @@ ] } }, - "status": "Service Unavailable" + "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"tags\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "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}}" @@ -86493,10 +90811,9 @@ "organizations", ":orgId", "subscriptions", - ":subscriptionId", - "assignTags" + ":subscriptionId" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags", + "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", "variable": [ { "description": "The unique identifier for the customer organization.", @@ -86509,14 +90826,19 @@ ] } }, - "status": "Too Many Requests" + "status": "Precondition Required" } ] - }, + } + ], + "name": "Partner Tags" + }, + { + "item": [ { - "name": "Subscription List on a given tag name or a set of tags", + "name": "List Workspace Locations", "request": { - "description": "For a partner organization fetch all it's subscriptions with their tag list for a given tag names.\nThis API can be used by partner full admins, partner admins and admin read-only partners.", + "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nList workspace locations. Use query parameters to filter the response. The `orgId` parameter can only be used by admin users of another\norganization (such as partners). The `displayName`, `address`, `countryCode` and `cityName` parameters are all optional.\nRequires an administrator auth token with the `spark-admin:workspace_locations_read` scope.", "header": [ { "key": "Accept", @@ -86529,23 +90851,36 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "subscriptions" + "workspaceLocations" ], "query": [ { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" + "description": "Location display name.", + "key": "displayName", + "value": "" + }, + { + "description": "Location address.", + "key": "address", + "value": "" + }, + { + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", + "value": "" + }, + { + "description": "Location city name.", + "key": "cityName", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, "response": [ @@ -86564,23 +90899,36 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "subscriptions" + "workspaceLocations" ], "query": [ { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" + "description": "Location display name.", + "key": "displayName", + "value": "" + }, + { + "description": "Location address.", + "key": "address", + "value": "" + }, + { + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", + "value": "" + }, + { + "description": "Location city name.", + "key": "cityName", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, "status": "Gone" @@ -86600,23 +90948,36 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "subscriptions" + "workspaceLocations" ], "query": [ { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" + "description": "Location display name.", + "key": "displayName", + "value": "" + }, + { + "description": "Location address.", + "key": "address", + "value": "" + }, + { + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", + "value": "" + }, + { + "description": "Location city name.", + "key": "cityName", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, "status": "Internal Server Error" @@ -86624,10 +90985,10 @@ { "_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", @@ -86636,70 +90997,47 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "subscriptions" + "workspaceLocations" ], "query": [ { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" - } - ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" - } - }, - "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": [ - "partner", - "tags", - "subscriptions" - ], - "query": [ + "description": "Location display name.", + "key": "displayName", + "value": "" + }, { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "Location address.", + "key": "address", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", + "value": "" + }, + { + "description": "Location city name.", + "key": "cityName", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, - "status": "Not Found" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 400, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], "method": "GET", @@ -86708,108 +91046,39 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "subscriptions" + "workspaceLocations" ], "query": [ { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" - } - ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" - } - }, - "status": "Precondition Required" - }, - { - "_postman_previewlanguage": "json", - "body": "[\n {\n \"orgName\": \"\",\n \"orgId\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"subscriptionId\": \"\",\n \"trial\": \"\"\n },\n {\n \"orgName\": \"\",\n \"orgId\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"subscriptionId\": \"\",\n \"trial\": \"\"\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": [ - "partner", - "tags", - "subscriptions" - ], - "query": [ - { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "Location display name.", + "key": "displayName", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" - } - ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" - } - }, - "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": [ - "partner", - "tags", - "subscriptions" - ], - "query": [ + "description": "Location address.", + "key": "address", + "value": "" + }, { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" + "description": "Location city name.", + "key": "cityName", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, - "status": "Forbidden" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", @@ -86826,23 +91095,36 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "subscriptions" + "workspaceLocations" ], "query": [ { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" + "description": "Location display name.", + "key": "displayName", + "value": "" + }, + { + "description": "Location address.", + "key": "address", + "value": "" + }, + { + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", + "value": "" + }, + { + "description": "Location city name.", + "key": "cityName", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, "status": "Unauthorized" @@ -86850,10 +91132,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 503, "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": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -86862,26 +91144,39 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "subscriptions" + "workspaceLocations" ], "query": [ { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" + "description": "Location display name.", + "key": "displayName", + "value": "" + }, + { + "description": "Location address.", + "key": "address", + "value": "" + }, + { + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", + "value": "" + }, + { + "description": "Location city name.", + "key": "cityName", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, - "status": "Too Many Requests" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", @@ -86898,23 +91193,36 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "subscriptions" + "workspaceLocations" ], "query": [ { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" + "description": "Location display name.", + "key": "displayName", + "value": "" + }, + { + "description": "Location address.", + "key": "address", + "value": "" + }, + { + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", + "value": "" + }, + { + "description": "Location city name.", + "key": "cityName", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, "status": "Gateway Timeout" @@ -86922,10 +91230,10 @@ { "_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", @@ -86934,70 +91242,47 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "subscriptions" + "workspaceLocations" ], "query": [ { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" - } - ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" - } - }, - "status": "Bad Request" - }, - { - "_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": [ - "partner", - "tags", - "subscriptions" - ], - "query": [ + "description": "Location display name.", + "key": "displayName", + "value": "" + }, { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "Location address.", + "key": "address", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", + "value": "" + }, + { + "description": "Location city name.", + "key": "cityName", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Too Many Requests" }, { "_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", @@ -87006,34 +91291,47 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "subscriptions" + "workspaceLocations" ], "query": [ { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" + "description": "Location display name.", + "key": "displayName", + "value": "" + }, + { + "description": "Location address.", + "key": "address", + "value": "" + }, + { + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", + "value": "" + }, + { + "description": "Location city name.", + "key": "cityName", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, - "status": "Service Unavailable" + "status": "Precondition Required" }, { "_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": { "header": [], "method": "GET", @@ -87042,34 +91340,47 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "subscriptions" + "workspaceLocations" ], "query": [ { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "Location display name.", + "key": "displayName", + "value": "" + }, + { + "description": "Location address.", + "key": "address", + "value": "" + }, + { + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" + "description": "Location city name.", + "key": "cityName", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, - "status": "Method Not Allowed" + "status": "Forbidden" }, { "_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": "GET", @@ -87078,34 +91389,47 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "subscriptions" + "workspaceLocations" ], "query": [ { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" + "description": "Location display name.", + "key": "displayName", + "value": "" + }, + { + "description": "Location address.", + "key": "address", + "value": "" + }, + { + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", + "value": "" + }, + { + "description": "Location city name.", + "key": "cityName", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, - "status": "Conflict" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 502, "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 Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -87114,75 +91438,47 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "subscriptions" + "workspaceLocations" ], "query": [ { - "description": "A comma separated list of tags to filter by.", - "key": "tags", + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", "value": "" }, { - "description": "Value must be between 1 and 100, inclusive.", - "key": "max", - "value": "" + "description": "Location display name.", + "key": "displayName", + "value": "" + }, + { + "description": "Location address.", + "key": "address", + "value": "" + }, + { + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", + "value": "" + }, + { + "description": "Location city name.", + "key": "cityName", + "value": "" } ], - "raw": "{{baseUrl}}/partner/tags/subscriptions?tags=&max=" + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, - "status": "Unsupported Media Type" - } - ] - }, - { - "name": "Fetch a Subscription", - "request": { - "description": "For a given partner org, customer org and external subscription id, fetch subscription details with its associated tags.\nThis API can be used by partner full admins, partner admins and admin read-only partners.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" - ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ - { - "description": "The unique identifier for the customer organization.", - "key": "orgId", - "value": "" - }, - { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId", - "value": "" - } - ] - } - }, - "response": [ + "status": "Bad Gateway" + }, { "_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": "GET", @@ -87191,35 +91487,47 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" + "workspaceLocations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ + "query": [ { - "description": "The unique identifier for the customer organization.", - "key": "orgId" + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" }, { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId" + "description": "Location display name.", + "key": "displayName", + "value": "" + }, + { + "description": "Location address.", + "key": "address", + "value": "" + }, + { + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", + "value": "" + }, + { + "description": "Location city name.", + "key": "cityName", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 415, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -87228,31 +91536,43 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" + "workspaceLocations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ + "query": [ { - "description": "The unique identifier for the customer organization.", - "key": "orgId" + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" }, { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId" + "description": "Location display name.", + "key": "displayName", + "value": "" + }, + { + "description": "Location address.", + "key": "address", + "value": "" + }, + { + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", + "value": "" + }, + { + "description": "Location city name.", + "key": "cityName", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, - "status": "Bad Request" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "json", - "body": "{\n \"orgName\": \"\",\n \"orgId\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"subscriptionId\": \"\",\n \"trial\": \"\"\n}", + "body": "{\n \"items\": [\n {\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n },\n {\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -87275,24 +91595,36 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" + "workspaceLocations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ + "query": [ { - "description": "The unique identifier for the customer organization.", - "key": "orgId" + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" }, { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId" + "description": "Location display name.", + "key": "displayName", + "value": "" + }, + { + "description": "Location address.", + "key": "address", + "value": "" + }, + { + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", + "value": "" + }, + { + "description": "Location city name.", + "key": "cityName", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, "status": "OK" @@ -87300,10 +91632,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 405, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -87312,64 +91644,114 @@ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" + "workspaceLocations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ + "query": [ { - "description": "The unique identifier for the customer organization.", - "key": "orgId" + "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" }, { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId" + "description": "Location display name.", + "key": "displayName", + "value": "" + }, + { + "description": "Location address.", + "key": "address", + "value": "" + }, + { + "description": "Location country code (ISO 3166-1).", + "key": "countryCode", + "value": "" + }, + { + "description": "Location city name.", + "key": "cityName", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" } }, - "status": "Unauthorized" + "status": "Method Not Allowed" + } + ] + }, + { + "name": "Create a Workspace Location", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" }, + "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nCreate a location. The `cityName` and `notes` parameters are optional, and omitting them will result in the creation of a location without values for those attributes.\nRequires an administrator auth token with the `spark-admin:workspace_locations_write` scope.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "workspaceLocations" + ], + "raw": "{{baseUrl}}/workspaceLocations" + } + }, + "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 428, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "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 \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" + "workspaceLocations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ - { - "description": "The unique identifier for the customer organization.", - "key": "orgId" - }, - { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId" - } - ] + "raw": "{{baseUrl}}/workspaceLocations" } }, - "status": "Gone" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", @@ -87379,31 +91761,31 @@ "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" + "workspaceLocations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ - { - "description": "The unique identifier for the customer organization.", - "key": "orgId" - }, - { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId" - } - ] + "raw": "{{baseUrl}}/workspaceLocations" } }, "status": "Internal Server Error" @@ -87411,224 +91793,187 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 400, "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": "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": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" - ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ - { - "description": "The unique identifier for the customer organization.", - "key": "orgId" - }, - { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } - ] - } - }, - "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": { - "header": [], - "method": "GET", + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" + "workspaceLocations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ - { - "description": "The unique identifier for the customer organization.", - "key": "orgId" - }, - { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId" - } - ] + "raw": "{{baseUrl}}/workspaceLocations" } }, - "status": "Method Not Allowed" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 502, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "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 \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" + "workspaceLocations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ - { - "description": "The unique identifier for the customer organization.", - "key": "orgId" - }, - { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId" - } - ] + "raw": "{{baseUrl}}/workspaceLocations" } }, - "status": "Service Unavailable" + "status": "Bad Gateway" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" + "workspaceLocations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ - { - "description": "The unique identifier for the customer organization.", - "key": "orgId" - }, - { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId" - } - ] + "raw": "{{baseUrl}}/workspaceLocations" } }, - "status": "Not Found" + "status": "Service Unavailable" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" + "workspaceLocations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ - { - "description": "The unique identifier for the customer organization.", - "key": "orgId" - }, - { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId" - } - ] + "raw": "{{baseUrl}}/workspaceLocations" } }, - "status": "Gateway Timeout" + "status": "Conflict" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" + "workspaceLocations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ - { - "description": "The unique identifier for the customer organization.", - "key": "orgId" - }, - { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId" - } - ] + "raw": "{{baseUrl}}/workspaceLocations" } }, - "status": "Bad Gateway" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -87638,31 +91983,31 @@ "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" + "workspaceLocations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ - { - "description": "The unique identifier for the customer organization.", - "key": "orgId" - }, - { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId" - } - ] + "raw": "{{baseUrl}}/workspaceLocations" } }, "status": "Unsupported Media Type" @@ -87670,180 +92015,148 @@ { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" + "workspaceLocations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ - { - "description": "The unique identifier for the customer organization.", - "key": "orgId" - }, - { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId" - } - ] + "raw": "{{baseUrl}}/workspaceLocations" } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 409, + "_postman_previewlanguage": "json", + "body": "{\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}", + "code": 201, "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": "Created", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" + "workspaceLocations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ - { - "description": "The unique identifier for the customer organization.", - "key": "orgId" - }, - { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId" - } - ] + "raw": "{{baseUrl}}/workspaceLocations" } }, - "status": "Conflict" + "status": "Created" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "partner", - "tags", - "organizations", - ":orgId", - "subscriptions", - ":subscriptionId" + "workspaceLocations" ], - "raw": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId", - "variable": [ - { - "description": "The unique identifier for the customer organization.", - "key": "orgId" - }, - { - "description": "The unique identifier for the subscription.", - "key": "subscriptionId" - } - ] + "raw": "{{baseUrl}}/workspaceLocations" } }, - "status": "Precondition Required" - } - ] - } - ], - "name": "Partner Tags" - }, - { - "item": [ - { - "name": "List Workspace Locations", - "request": { - "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nList workspace locations. Use query parameters to filter the response. The `orgId` parameter can only be used by admin users of another\norganization (such as partners). The `displayName`, `address`, `countryCode` and `cityName` parameters are all optional.\nRequires an administrator auth token with the `spark-admin:workspace_locations_read` scope.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "workspaceLocations" - ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, - { - "description": "Location city name.", - "key": "cityName", - "value": "" - } - ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" - } - }, - "response": [ + "status": "Method Not Allowed" + }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -87851,97 +92164,73 @@ "path": [ "workspaceLocations" ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, - { - "description": "Location city name.", - "key": "cityName", - "value": "" - } - ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" + "raw": "{{baseUrl}}/workspaceLocations" } }, - "status": "Gone" + "status": "Gateway Timeout" }, { "_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": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "workspaceLocations" - ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, - { - "description": "Location city name.", - "key": "cityName", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" + "path": [ + "workspaceLocations" + ], + "raw": "{{baseUrl}}/workspaceLocations" } }, - "status": "Internal Server Error" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -87949,48 +92238,36 @@ "path": [ "workspaceLocations" ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, - { - "description": "Location city name.", - "key": "cityName", - "value": "" - } - ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" + "raw": "{{baseUrl}}/workspaceLocations" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 410, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -87998,48 +92275,36 @@ "path": [ "workspaceLocations" ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, - { - "description": "Location city name.", - "key": "cityName", - "value": "" - } - ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" + "raw": "{{baseUrl}}/workspaceLocations" } }, - "status": "Bad Request" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 404, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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 \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -88047,45 +92312,50 @@ "path": [ "workspaceLocations" ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, - { - "description": "Location city name.", - "key": "cityName", - "value": "" - } - ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" + "raw": "{{baseUrl}}/workspaceLocations" } }, - "status": "Unauthorized" - }, + "status": "Not Found" + } + ] + }, + { + "name": "Get a Workspace Location Details", + "request": { + "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nShows details for a location, by ID. Specify the location ID in the `locationId` parameter in the URI.\nRequires an administrator auth token with the `spark-admin:workspace_locations_read` scope.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "workspaceLocations", + ":locationId" + ], + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId", + "value": "" + } + ] + } + }, + "response": [ { "_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", @@ -88094,47 +92364,27 @@ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ { - "description": "Location city name.", - "key": "cityName", - "value": "" + "description": "A unique identifier for the location.", + "key": "locationId" } - ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" + ] } }, - "status": "Service Unavailable" + "status": "Gateway Timeout" }, { "_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", @@ -88143,39 +92393,19 @@ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ { - "description": "Location city name.", - "key": "cityName", - "value": "" + "description": "A unique identifier for the location.", + "key": "locationId" } - ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" + ] } }, - "status": "Gateway Timeout" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", @@ -88192,36 +92422,16 @@ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ { - "description": "Location city name.", - "key": "cityName", - "value": "" + "description": "A unique identifier for the location.", + "key": "locationId" } - ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" + ] } }, "status": "Too Many Requests" @@ -88229,10 +92439,10 @@ { "_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": "GET", @@ -88241,47 +92451,27 @@ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ { - "description": "Location city name.", - "key": "cityName", - "value": "" + "description": "A unique identifier for the location.", + "key": "locationId" } - ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" + ] } }, - "status": "Precondition Required" + "status": "Forbidden" }, { "_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", @@ -88290,39 +92480,19 @@ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ { - "description": "Location city name.", - "key": "cityName", - "value": "" + "description": "A unique identifier for the location.", + "key": "locationId" } - ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" + ] } }, - "status": "Forbidden" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", @@ -88339,36 +92509,16 @@ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ { - "description": "Location city name.", - "key": "cityName", - "value": "" + "description": "A unique identifier for the location.", + "key": "locationId" } - ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" + ] } }, "status": "Not Found" @@ -88388,36 +92538,16 @@ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ { - "description": "Location city name.", - "key": "cityName", - "value": "" + "description": "A unique identifier for the location.", + "key": "locationId" } - ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" + ] } }, "status": "Bad Gateway" @@ -88425,10 +92555,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", @@ -88437,39 +92567,19 @@ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ { - "description": "Location city name.", - "key": "cityName", - "value": "" + "description": "A unique identifier for the location.", + "key": "locationId" } - ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" + ] } }, - "status": "Conflict" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", @@ -88486,98 +92596,48 @@ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ { - "description": "Location city name.", - "key": "cityName", - "value": "" + "description": "A unique identifier for the location.", + "key": "locationId" } - ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" + ] } }, "status": "Unsupported Media Type" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n },\n {\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 410, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ { - "description": "Location city name.", - "key": "cityName", - "value": "" + "description": "A unique identifier for the location.", + "key": "locationId" } - ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" + ] } }, - "status": "OK" + "status": "Gone" }, { "_postman_previewlanguage": "text", @@ -88594,151 +92654,87 @@ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "query": [ - { - "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "Location display name.", - "key": "displayName", - "value": "" - }, - { - "description": "Location address.", - "key": "address", - "value": "" - }, - { - "description": "Location country code (ISO 3166-1).", - "key": "countryCode", - "value": "" - }, + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ { - "description": "Location city name.", - "key": "cityName", - "value": "" + "description": "A unique identifier for the location.", + "key": "locationId" } - ], - "raw": "{{baseUrl}}/workspaceLocations?orgId=&displayName=&address=&countryCode=&cityName=" + ] } }, "status": "Method Not Allowed" - } - ] - }, - { - "name": "Create a Workspace Location", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" }, - "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nCreate a location. The `cityName` and `notes` parameters are optional, and omitting them will result in the creation of a location without values for those attributes.\nRequires an administrator auth token with the `spark-admin:workspace_locations_write` scope.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "workspaceLocations" - ], - "raw": "{{baseUrl}}/workspaceLocations" - } - }, - "response": [ { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "raw": "{{baseUrl}}/workspaceLocations" + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId" + } + ] } }, - "status": "Precondition Required" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "_postman_previewlanguage": "json", + "body": "{\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "raw": "{{baseUrl}}/workspaceLocations" + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId" + } + ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "text", @@ -88748,31 +92744,23 @@ "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 \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "raw": "{{baseUrl}}/workspaceLocations" + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId" + } + ] } }, "status": "Bad Request" @@ -88780,84 +92768,114 @@ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "raw": "{{baseUrl}}/workspaceLocations" + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId" + } + ] } }, - "status": "Bad Gateway" + "status": "Conflict" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "raw": "{{baseUrl}}/workspaceLocations" + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId" + } + ] } }, - "status": "Service Unavailable" + "status": "Unauthorized" + } + ] + }, + { + "name": "Update a Workspace Location", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" }, + "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nUpdates details for a location, by ID. Specify the location ID in the `locationId` parameter in the URI. The request should include all details for the location returned in a previous call to [Get Workspace Location Details](/docs/api/v1/workspace-locations/get-a-workspace-location-details). Omitting the optional `cityName` or `notes` fields will result in those fields no longer being defined for the location.\nRequires an administrator auth token with the `spark-admin:workspace_locations_write` scope.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "workspaceLocations", + ":locationId" + ], + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId", + "value": "" + } + ] + } + }, + "response": [ { "_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", @@ -88867,7 +92885,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" }, "header": [ { @@ -88875,26 +92893,33 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "raw": "{{baseUrl}}/workspaceLocations" + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId" + } + ] } }, - "status": "Conflict" + "status": "Internal Server Error" }, { "_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": "raw", @@ -88904,7 +92929,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" }, "header": [ { @@ -88912,26 +92937,33 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "raw": "{{baseUrl}}/workspaceLocations" + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId" + } + ] } }, - "status": "Forbidden" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 502, "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 Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -88941,7 +92973,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" }, "header": [ { @@ -88949,26 +92981,33 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "raw": "{{baseUrl}}/workspaceLocations" + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId" + } + ] } }, - "status": "Unsupported Media Type" + "status": "Bad Gateway" }, { "_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", @@ -88978,7 +93017,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" }, "header": [ { @@ -88986,23 +93025,30 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "raw": "{{baseUrl}}/workspaceLocations" + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId" + } + ] } }, - "status": "Too Many Requests" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "json", "body": "{\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}", - "code": 201, + "code": 200, "cookie": [], "header": [ { @@ -89010,7 +93056,7 @@ "value": "application/json" } ], - "name": "Created", + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -89020,7 +93066,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" }, "header": [ { @@ -89032,26 +93078,33 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "raw": "{{baseUrl}}/workspaceLocations" + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId" + } + ] } }, - "status": "Created" + "status": "OK" }, { "_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", @@ -89061,7 +93114,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" }, "header": [ { @@ -89069,26 +93122,33 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "raw": "{{baseUrl}}/workspaceLocations" + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId" + } + ] } }, - "status": "Method Not Allowed" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 429, "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": "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", @@ -89098,7 +93158,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" }, "header": [ { @@ -89106,26 +93166,33 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "raw": "{{baseUrl}}/workspaceLocations" + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId" + } + ] } }, - "status": "Gateway Timeout" + "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": { "body": { "mode": "raw", @@ -89135,7 +93202,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" }, "header": [ { @@ -89143,18 +93210,25 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "raw": "{{baseUrl}}/workspaceLocations" + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gone" }, { "_postman_previewlanguage": "text", @@ -89172,7 +93246,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" }, "header": [ { @@ -89180,15 +93254,22 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "raw": "{{baseUrl}}/workspaceLocations" + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId" + } + ] } }, "status": "Unauthorized" @@ -89196,10 +93277,10 @@ { "_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": { "body": { "mode": "raw", @@ -89209,7 +93290,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" }, "header": [ { @@ -89217,26 +93298,33 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations" + "workspaceLocations", + ":locationId" ], - "raw": "{{baseUrl}}/workspaceLocations" + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId" + } + ] } }, - "status": "Gone" + "status": "Gateway Timeout" }, { "_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", @@ -89246,7 +93334,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" }, "header": [ { @@ -89254,61 +93342,7 @@ "value": "application/json" } ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "workspaceLocations" - ], - "raw": "{{baseUrl}}/workspaceLocations" - } - }, - "status": "Not Found" - } - ] - }, - { - "name": "Get a Workspace Location Details", - "request": { - "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nShows details for a location, by ID. Specify the location ID in the `locationId` parameter in the URI.\nRequires an administrator auth token with the `spark-admin:workspace_locations_read` scope.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "workspaceLocations", - ":locationId" - ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", - "variable": [ - { - "description": "A unique identifier for the location.", - "key": "locationId", - "value": "" - } - ] - } - }, - "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": { - "header": [], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -89326,18 +93360,33 @@ ] } }, - "status": "Gateway Timeout" + "status": "Bad Request" }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -89355,18 +93404,33 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Method Not Allowed" }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -89384,18 +93448,33 @@ ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 423, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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 \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -89413,18 +93492,33 @@ ] } }, - "status": "Forbidden" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 409, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. 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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -89442,18 +93536,33 @@ ] } }, - "status": "Service Unavailable" + "status": "Conflict" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -89471,18 +93580,45 @@ ] } }, - "status": "Not Found" - }, + "status": "Service Unavailable" + } + ] + }, + { + "name": "Delete a Workspace Location", + "request": { + "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nDeletes a location, by ID. The workspaces associated to that location will no longer have a location, but a new location can be reassigned to them.\nRequires an administrator auth token with the `spark-admin:workspace_locations_write` scope.", + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "workspaceLocations", + ":locationId" + ], + "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId", + "value": "" + } + ] + } + }, + "response": [ { "_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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -89500,18 +93636,18 @@ ] } }, - "status": "Bad Gateway" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 204, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "No Content", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -89529,18 +93665,18 @@ ] } }, - "status": "Precondition Required" + "status": "No Content" }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -89558,7 +93694,7 @@ ] } }, - "status": "Unsupported Media Type" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", @@ -89569,7 +93705,7 @@ "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -89592,13 +93728,13 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 504, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method 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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -89616,18 +93752,18 @@ ] } }, - "status": "Method Not Allowed" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 404, "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": "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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -89645,28 +93781,18 @@ ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 409, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -89684,18 +93810,18 @@ ] } }, - "status": "OK" + "status": "Conflict" }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -89713,18 +93839,18 @@ ] } }, - "status": "Bad Request" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 401, "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": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -89742,18 +93868,18 @@ ] } }, - "status": "Conflict" + "status": "Unauthorized" }, { "_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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -89771,79 +93897,18 @@ ] } }, - "status": "Unauthorized" - } - ] - }, - { - "name": "Update a Workspace Location", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" + "status": "Locked (WebDAV) (RFC 4918)" }, - "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nUpdates details for a location, by ID. Specify the location ID in the `locationId` parameter in the URI. The request should include all details for the location returned in a previous call to [Get Workspace Location Details](/docs/api/v1/workspace-locations/get-a-workspace-location-details). Omitting the optional `cityName` or `notes` fields will result in those fields no longer being defined for the location.\nRequires an administrator auth token with the `spark-admin:workspace_locations_write` scope.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "workspaceLocations", - ":locationId" - ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", - "variable": [ - { - "description": "A unique identifier for the location.", - "key": "locationId", - "value": "" - } - ] - } - }, - "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 428, "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": "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 \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -89861,33 +93926,18 @@ ] } }, - "status": "Internal Server Error" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 502, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "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 \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -89905,33 +93955,18 @@ ] } }, - "status": "Precondition Required" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 415, "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 \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "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}}" @@ -89949,33 +93984,18 @@ ] } }, - "status": "Bad Gateway" + "status": "Unsupported Media Type" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -89993,42 +94013,18 @@ ] } }, - "status": "Unsupported Media Type" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -90046,33 +94042,18 @@ ] } }, - "status": "OK" + "status": "Bad Request" }, { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -90090,42 +94071,61 @@ ] } }, - "status": "Forbidden" - }, + "status": "Service Unavailable" + } + ] + }, + { + "name": "List Workspace Location Floors", + "request": { + "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nList workspace location floors.\nRequires an administrator auth token with the `spark-admin:workspace_locations_read` scope.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "workspaceLocations", + ":locationId", + "floors" + ], + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId", + "value": "" + } + ] + } + }, + "response": [ { "_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 \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90134,42 +94134,28 @@ ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90178,42 +94164,28 @@ ] } }, - "status": "Gone" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 405, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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 \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90222,42 +94194,28 @@ ] } }, - "status": "Unauthorized" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 502, "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 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 \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90266,42 +94224,28 @@ ] } }, - "status": "Gateway Timeout" + "status": "Bad Gateway" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90310,42 +94254,28 @@ ] } }, - "status": "Bad Request" + "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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90354,42 +94284,28 @@ ] } }, - "status": "Method Not Allowed" + "status": "Unsupported Media Type" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90398,7 +94314,7 @@ ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -90408,32 +94324,18 @@ "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 \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90452,32 +94354,18 @@ "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 \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90491,37 +94379,63 @@ { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "workspaceLocations", + ":locationId", + "floors" + ], + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId" } - }, - "raw": "{\n \"displayName\": \"\",\n \"address\": \"\",\n \"countryCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"id\": \"\",\n \"cityName\": \"\",\n \"notes\": \"\"\n}" - }, + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"floorNumber\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\"\n },\n {\n \"floorNumber\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90530,54 +94444,28 @@ ] } }, - "status": "Service Unavailable" - } - ] - }, - { - "name": "Delete a Workspace Location", - "request": { - "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nDeletes a location, by ID. The workspaces associated to that location will no longer have a location, but a new location can be reassigned to them.\nRequires an administrator auth token with the `spark-admin:workspace_locations_write` scope.", - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "workspaceLocations", - ":locationId" - ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", - "variable": [ - { - "description": "A unique identifier for the location.", - "key": "locationId", - "value": "" - } - ] - } - }, - "response": [ + "status": "OK" + }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90586,27 +94474,28 @@ ] } }, - "status": "Internal Server Error" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 410, "cookie": [], "header": [], - "name": "No Content", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90615,27 +94504,28 @@ ] } }, - "status": "No Content" + "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", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90644,27 +94534,28 @@ ] } }, - "status": "Method Not Allowed" + "status": "Bad Request" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90673,27 +94564,28 @@ ] } }, - "status": "Gone" + "status": "Service Unavailable" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90702,27 +94594,90 @@ ] } }, - "status": "Gateway Timeout" + "status": "Not Found" + } + ] + }, + { + "name": "Create a Workspace Location Floor", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" }, + "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nCreate 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:workspace_locations_write` scope.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "workspaceLocations", + ":locationId", + "floors" + ], + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId", + "value": "" + } + ] + } + }, + "response": [ { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90731,27 +94686,43 @@ ] } }, - "status": "Not Found" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90760,27 +94731,43 @@ ] } }, - "status": "Conflict" + "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: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90789,27 +94776,43 @@ ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90818,27 +94821,43 @@ ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90847,27 +94866,43 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Conflict" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90876,27 +94911,43 @@ ] } }, - "status": "Precondition Required" + "status": "Gateway Timeout" }, { "_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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90905,27 +94956,43 @@ ] } }, - "status": "Bad Gateway" + "status": "Internal Server Error" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90934,27 +95001,43 @@ ] } }, - "status": "Unsupported Media Type" + "status": "Method Not Allowed" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90963,27 +95046,43 @@ ] } }, - "status": "Forbidden" + "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": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -90992,27 +95091,43 @@ ] } }, - "status": "Bad Request" + "status": "Bad Gateway" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "workspaceLocations", - ":locationId" + ":locationId", + "floors" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", "variable": [ { "description": "A unique identifier for the location.", @@ -91021,51 +95136,33 @@ ] } }, - "status": "Service Unavailable" - } - ] - }, - { - "name": "List Workspace Location Floors", - "request": { - "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nList workspace location floors.\nRequires an administrator auth token with the `spark-admin:workspace_locations_read` scope.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "workspaceLocations", - ":locationId", - "floors" - ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", - "variable": [ - { - "description": "A unique identifier for the location.", - "key": "locationId", - "value": "" - } - ] - } - }, - "response": [ + "status": "Not Found" + }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -91084,18 +95181,42 @@ ] } }, - "status": "Internal Server Error" + "status": "Unsupported Media Type" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 429, + "_postman_previewlanguage": "json", + "body": "{\n \"floorNumber\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\"\n}", + "code": 201, "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": "Created", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -91114,18 +95235,33 @@ ] } }, - "status": "Too Many Requests" + "status": "Created" }, { "_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.", - "originalRequest": { - "header": [], - "method": "GET", + "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 \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -91144,18 +95280,33 @@ ] } }, - "status": "Method Not Allowed" + "status": "Precondition Required" }, { "_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 \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -91174,18 +95325,33 @@ ] } }, - "status": "Bad Gateway" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 429, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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 \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -91204,8 +95370,47 @@ ] } }, - "status": "Unauthorized" - }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "Get a Workspace Location Floor Details", + "request": { + "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nShows 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:workspace_locations_read` scope.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "workspaceLocations", + ":locationId", + "floors", + ":floorId" + ], + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId", + "value": "" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "text", "body": null, @@ -91223,13 +95428,18 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } @@ -91239,10 +95449,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 504, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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", @@ -91253,26 +95463,31 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Forbidden" + "status": "Gateway Timeout" }, { "_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", @@ -91283,18 +95498,23 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", @@ -91313,13 +95533,18 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } @@ -91329,10 +95554,10 @@ { "_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", @@ -91343,22 +95568,27 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Precondition Required" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"floorNumber\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\"\n },\n {\n \"floorNumber\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\"\n }\n ]\n}", + "body": "{\n \"floorNumber\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -91383,13 +95613,18 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } @@ -91399,10 +95634,10 @@ { "_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", @@ -91413,26 +95648,31 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Gateway Timeout" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { "header": [], "method": "GET", @@ -91443,26 +95683,31 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Gone" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 410, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -91473,26 +95718,31 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Bad Request" + "status": "Gone" }, { "_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", @@ -91503,26 +95753,31 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Service Unavailable" + "status": "Precondition Required" }, { "_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", @@ -91533,136 +95788,34 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" - } - ] - } - }, - "status": "Not Found" - } - ] - }, - { - "name": "Create a Workspace Location Floor", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nCreate 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:workspace_locations_write` scope.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "workspaceLocations", - ":locationId", - "floors" - ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", - "variable": [ - { - "description": "A unique identifier for the location.", - "key": "locationId", - "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "workspaceLocations", - ":locationId", - "floors" - ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", - "variable": [ + }, { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 502, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "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 \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -91670,18 +95823,23 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Service Unavailable" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", @@ -91691,23 +95849,8 @@ "header": [], "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -91715,13 +95858,18 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } @@ -91731,28 +95879,13 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 400, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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 \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -91760,89 +95893,34 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" - } - ] - } - }, - "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 \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "workspaceLocations", - ":locationId", - "floors" - ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", - "variable": [ + }, { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Conflict" + "status": "Bad Request" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -91850,18 +95928,23 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Gateway Timeout" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -91871,23 +95954,8 @@ "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 \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -91895,26 +95963,84 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, "status": "Internal Server Error" + } + ] + }, + { + "name": "Update a Workspace Location Floor", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" }, + "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nUpdates 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 Workspace Location Floor Details](/docs/api/v1/workspace-locations/get-a-workspace-location-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:workspace_locations_write` scope.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "workspaceLocations", + ":locationId", + "floors", + ":floorId" + ], + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId", + "value": "" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId", + "value": "" + } + ] + } + }, + "response": [ { "_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", @@ -91932,7 +96058,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -91940,26 +96066,31 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Method Not Allowed" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 400, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "body": { "mode": "raw", @@ -91977,7 +96108,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -91985,18 +96116,23 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Gone" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", @@ -92022,7 +96158,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -92030,13 +96166,18 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } @@ -92046,10 +96187,10 @@ { "_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": { "body": { "mode": "raw", @@ -92067,7 +96208,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -92075,26 +96216,31 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Not Found" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { "body": { "mode": "raw", @@ -92112,7 +96258,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -92120,31 +96266,31 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Unsupported Media Type" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"floorNumber\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\"\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", @@ -92160,13 +96306,9 @@ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -92174,26 +96316,31 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Created" + "status": "Internal Server Error" }, { "_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", @@ -92211,7 +96358,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -92219,26 +96366,31 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Precondition Required" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 504, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -92256,7 +96408,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -92264,26 +96416,31 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Bad Request" + "status": "Gateway Timeout" }, { "_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", @@ -92301,7 +96458,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -92309,68 +96466,49 @@ "path": [ "workspaceLocations", ":locationId", - "floors" + "floors", + ":floorId" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors", + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "variable": [ { "description": "A unique identifier for the location.", "key": "locationId" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId" } ] } }, - "status": "Too Many Requests" - } - ] - }, - { - "name": "Get a Workspace Location Floor Details", - "request": { - "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nShows 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:workspace_locations_read` scope.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" - ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ - { - "description": "A unique identifier for the location.", - "key": "locationId", - "value": "" - }, - { - "description": "A unique identifier for the floor.", - "key": "floorId", - "value": "" - } - ] - } - }, - "response": [ + "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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -92394,18 +96532,33 @@ ] } }, - "status": "Unsupported Media Type" + "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -92429,7 +96582,7 @@ ] } }, - "status": "Gateway Timeout" + "status": "Conflict" }, { "_postman_previewlanguage": "text", @@ -92439,8 +96592,23 @@ "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -92469,13 +96637,28 @@ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -92499,18 +96682,33 @@ ] } }, - "status": "Conflict" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 403, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "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 \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -92534,7 +96732,7 @@ ] } }, - "status": "Service Unavailable" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -92549,13 +96747,27 @@ ], "name": "OK", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -92581,76 +96793,6 @@ }, "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": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" - ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ - { - "description": "A unique identifier for the location.", - "key": "locationId" - }, - { - "description": "A unique identifier for the floor.", - "key": "floorId" - } - ] - } - }, - "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": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" - ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ - { - "description": "A unique identifier for the location.", - "key": "locationId" - }, - { - "description": "A unique identifier for the floor.", - "key": "floorId" - } - ] - } - }, - "status": "Not Found" - }, { "_postman_previewlanguage": "text", "body": null, @@ -92659,8 +96801,23 @@ "header": [], "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -92685,17 +96842,51 @@ } }, "status": "Gone" - }, + } + ] + }, + { + "name": "Delete a Workspace Location Floor", + "request": { + "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nDeletes a floor, by ID.\nRequires an administrator auth token with the `spark-admin:workspace_locations_write` scope.", + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "workspaceLocations", + ":locationId", + "floors", + ":floorId" + ], + "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", + "variable": [ + { + "description": "A unique identifier for the location.", + "key": "locationId", + "value": "" + }, + { + "description": "A unique identifier for the floor.", + "key": "floorId", + "value": "" + } + ] + } + }, + "response": [ { "_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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -92719,18 +96910,18 @@ ] } }, - "status": "Precondition Required" + "status": "Method Not Allowed" }, { "_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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -92754,18 +96945,18 @@ ] } }, - "status": "Method Not Allowed" + "status": "Forbidden" }, { "_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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -92789,7 +96980,7 @@ ] } }, - "status": "Bad Gateway" + "status": "Not Found" }, { "_postman_previewlanguage": "text", @@ -92800,7 +96991,7 @@ "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -92829,13 +97020,13 @@ { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -92859,18 +97050,18 @@ ] } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -92894,18 +97085,18 @@ ] } }, - "status": "Forbidden" + "status": "Precondition Required" }, { "_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", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -92929,86 +97120,18 @@ ] } }, - "status": "Internal Server Error" - } - ] - }, - { - "name": "Update a Workspace Location Floor", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" + "status": "No Content" }, - "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nUpdates 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 Workspace Location Floor Details](/docs/api/v1/workspace-locations/get-a-workspace-location-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:workspace_locations_write` scope.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" - ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ - { - "description": "A unique identifier for the location.", - "key": "locationId", - "value": "" - }, - { - "description": "A unique identifier for the floor.", - "key": "floorId", - "value": "" - } - ] - } - }, - "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 409, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. 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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -93032,33 +97155,18 @@ ] } }, - "status": "Service Unavailable" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 504, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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 \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -93082,33 +97190,18 @@ ] } }, - "status": "Bad Request" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 410, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -93132,33 +97225,18 @@ ] } }, - "status": "Bad Gateway" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 415, "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": "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 \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -93182,33 +97260,18 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 429, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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 \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -93232,33 +97295,18 @@ ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 503, "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": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -93282,33 +97330,18 @@ ] } }, - "status": "Internal Server Error" + "status": "Service Unavailable" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -93332,33 +97365,18 @@ ] } }, - "status": "Not Found" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 502, "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 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 \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -93382,33 +97400,18 @@ ] } }, - "status": "Gateway Timeout" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 423, "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": "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 \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -93432,316 +97435,486 @@ ] } }, - "status": "Unsupported Media Type" - }, + "status": "Locked (WebDAV) (RFC 4918)" + } + ] + } + ], + "name": "Workspace Locations" + }, + { + "item": [ + { + "name": "Workspace Metrics", + "request": { + "description": "Get metric data for the specified workspace and metric name, optionally aggregated over a specified time period.\n\n* The `workspaceId` and `metricName` parameters indicate which workspace to fetch metrics for and what kind of metrics to get.\n\n* When executing an aggregated query, the result bucket start times will be truncated to the start of an hour or a day, depending on\nthe aggregation interval. However, the buckets will not contain data from outside the requested time range. For example, when\npassing `from=2020-10-21T10:34:56.000Z` and `aggregation=hourly`, the first output bucket would start at `2020-10-21T10:00:00.000Z`,\nbut the bucket would only aggregate data timestamped after `10:34:56`.\n\n* For aggregation modes `none` and `hourly`, the maximum time span is 48 hours. For aggregation mode `daily`, the maximum\ntime span is 30 days.\n\n* If the aggregation mode query parameter is set to `none`, the returned data in the response will be an array of items with the `deviceId`, `timestamp` and the raw `value`.\n\n* If the aggregation mode is `hourly` or `daily`, the returned data in the response will be an array of items with the `start` and `end` of the aggregation time bucket, and the `mean`, `max` and `min` values of the requested value. Note that zeroes and negative values are ignored. For example, this means that the `peopleCount` mean value should be interpreted as the average number of people in the room _when it is in use_.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "workspaceMetrics" + ], + "query": [ + { + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" + }, + { + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" + } + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + } + }, + "response": [ { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "workspaceMetrics" + ], + "query": [ + { + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" + }, + { + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" } - }, - "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + } + }, + "status": "Method Not Allowed" + }, + { + "_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": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" } - ] + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" } }, - "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" } - ] + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" } }, - "status": "Conflict" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 400, "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": "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 \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" } - ] + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" } }, - "status": "Too Many Requests" + "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" } - ] + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" } }, - "status": "Method Not Allowed" + "status": "Precondition Required" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" } - ] + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" } }, - "status": "Forbidden" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"floorNumber\": \"\",\n \"id\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 429, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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 \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" } - ] + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", @@ -93751,326 +97924,479 @@ "header": [], "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"floorNumber\": \"\",\n \"displayName\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" - } - ] - } - }, - "status": "Gone" - } - ] - }, - { - "name": "Delete a Workspace Location Floor", - "request": { - "description": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nDeletes a floor, by ID.\nRequires an administrator auth token with the `spark-admin:workspace_locations_write` scope.", - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" - ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ - { - "description": "A unique identifier for the location.", - "key": "locationId", - "value": "" - }, - { - "description": "A unique identifier for the floor.", - "key": "floorId", - "value": "" + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" + } + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" } - ] - } - }, - "response": [ + }, + "status": "Gone" + }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" } - ] + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" } }, - "status": "Method Not Allowed" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 504, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" } - ] + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" } }, - "status": "Forbidden" + "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}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" } - ] + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" } }, - "status": "Not Found" + "status": "Bad Gateway" }, { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" } - ] + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" } }, - "status": "Unauthorized" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 404, "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": "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}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" } - ] + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" } }, - "status": "Internal Server Error" + "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}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" } - ] + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" } }, - "status": "Precondition Required" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 204, + "_postman_previewlanguage": "json", + "body": "{\n \"workspaceId\": \"\",\n \"metricName\": \"peopleCount\",\n \"aggregation\": \"hourly\",\n \"from\": \"\",\n \"to\": \"\",\n \"unit\": \"fahrenheit\",\n \"sortBy\": \"newestFirst\",\n \"items\": [\n \"\",\n \"\"\n ]\n}", + "code": 200, "cookie": [], - "header": [], - "name": "No Content", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], - "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" } - ] + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" } }, - "status": "No Content" + "status": "OK" }, { "_postman_previewlanguage": "text", @@ -94081,101 +98407,204 @@ "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}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "The type of data to extract.", + "key": "metricName", + "value": "peopleCount" + }, + { + "description": "Time unit over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "key": "from", + "value": "" + }, + { + "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "key": "to", + "value": "" + }, + { + "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", + "key": "unit", + "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." + }, + { + "description": "Sort results.", + "key": "sortBy", + "value": "newestFirst" } - ] + ], + "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" } }, "status": "Conflict" - }, + } + ] + }, + { + "name": "Workspace Duration Metrics", + "request": { + "description": "Get metrics for how much time a workspace has been in the state given by the `measurement` parameter.\n\nFor example, if the measurement is `timeBooked` then the duration for which the workspace has been booked is returned. The `workspaceId` parameter indicates which workspace to fetch metrics for. If no `measurement` is given, the default value is `timeUsed`.\n\n* When executing a query, the result bucket start times will default to the start of an hour or a day, depending on\nthe aggregation interval. However, the buckets will not contain data from outside the requested time range. For example, when\npassing `from=2020-10-21T10:34:56.000Z` and `aggregation=hourly`, the first output bucket would start at `2020-10-21T10:00:00.000Z`,\nbut the bucket would only aggregate data timestamped after `10:34:56`.\n\n* For aggregation mode `hourly`, the maximum time span is 48 hours. For aggregation mode `daily`, the maximum\ntime span is 30 days.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "workspaceDurationMetrics" + ], + "query": [ + { + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" + }, + { + "description": "Unit of time over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" + }, + { + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", + "key": "from", + "value": "" + }, + { + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + } + }, + "response": [ { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceDurationMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "Unit of time over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" + }, + { + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", + "key": "from", + "value": "" + }, + { + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", + "key": "to", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" } }, - "status": "Gateway Timeout" + "status": "Unauthorized" }, { "_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}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceDurationMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "Unit of time over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" + }, + { + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", + "key": "from", + "value": "" + }, + { + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", + "key": "to", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" } }, - "status": "Gone" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", @@ -94186,28 +98615,42 @@ "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}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceDurationMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "Unit of time over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" + }, + { + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", + "key": "from", + "value": "" + }, + { + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", + "key": "to", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" } }, "status": "Unsupported Media Type" @@ -94215,37 +98658,51 @@ { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceDurationMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "Unit of time over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" + }, + { + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", + "key": "from", + "value": "" + }, + { + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", + "key": "to", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -94256,28 +98713,42 @@ "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceDurationMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "Unit of time over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" + }, + { + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", + "key": "from", + "value": "" + }, + { + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", + "key": "to", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" } }, "status": "Service Unavailable" @@ -94285,181 +98756,108 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 409, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceDurationMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" - } - ] - } - }, - "status": "Bad Request" - }, - { - "_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": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" - ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "description": "Unit of time over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", + "key": "from", + "value": "" + }, + { + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", + "key": "to", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" } }, - "status": "Bad Gateway" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 403, "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": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceLocations", - ":locationId", - "floors", - ":floorId" + "workspaceDurationMetrics" ], - "raw": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", - "variable": [ + "query": [ { - "description": "A unique identifier for the location.", - "key": "locationId" + "description": "ID of the workspace to get metrics for.", + "key": "workspaceId", + "value": "" }, { - "description": "A unique identifier for the floor.", - "key": "floorId" + "description": "Unit of time over which to aggregate measurements.", + "key": "aggregation", + "value": "hourly" + }, + { + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" + }, + { + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", + "key": "from", + "value": "" + }, + { + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", + "key": "to", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" } }, - "status": "Locked (WebDAV) (RFC 4918)" - } - ] - } - ], - "name": "Workspace Locations" - }, - { - "item": [ - { - "name": "Workspace Metrics", - "request": { - "description": "Get metric data for the specified workspace and metric name, optionally aggregated over a specified time period.\n\n* The `workspaceId` and `metricName` parameters indicate which workspace to fetch metrics for and what kind of metrics to get.\n\n* When executing an aggregated query, the result bucket start times will be truncated to the start of an hour or a day, depending on\nthe aggregation interval. However, the buckets will not contain data from outside the requested time range. For example, when\npassing `from=2020-10-21T10:34:56.000Z` and `aggregation=hourly`, the first output bucket would start at `2020-10-21T10:00:00.000Z`,\nbut the bucket would only aggregate data timestamped after `10:34:56`.\n\n* For aggregation modes `none` and `hourly`, the maximum time span is 48 hours. For aggregation mode `daily`, the maximum\ntime span is 30 days.\n\n* If the aggregation mode query parameter is set to `none`, the returned data in the response will be an array of items with the `deviceId`, `timestamp` and the raw `value`.\n\n* If the aggregation mode is `hourly` or `daily`, the returned data in the response will be an array of items with the `start` and `end` of the aggregation time bucket, and the `mean`, `max` and `min` values of the requested value. Note that zeroes and negative values are ignored. For example, this means that the `peopleCount` mean value should be interpreted as the average number of people in the room _when it is in use_.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "workspaceMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", - "key": "from", - "value": "" - }, - { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", - "key": "to", - "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" - } - ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" - } - }, - "response": [ + "status": "Forbidden" + }, { "_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": "GET", @@ -94468,7 +98866,7 @@ "{{baseUrl}}" ], "path": [ - "workspaceMetrics" + "workspaceDurationMetrics" ], "query": [ { @@ -94477,48 +98875,38 @@ "value": "" }, { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", + "description": "Unit of time over which to aggregate measurements.", "key": "aggregation", "value": "hourly" }, { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" + }, + { + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", "key": "from", "value": "" }, { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", "key": "to", "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" } ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" } }, - "status": "Method Not Allowed" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 502, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -94527,7 +98915,7 @@ "{{baseUrl}}" ], "path": [ - "workspaceMetrics" + "workspaceDurationMetrics" ], "query": [ { @@ -94536,48 +98924,38 @@ "value": "" }, { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", + "description": "Unit of time over which to aggregate measurements.", "key": "aggregation", "value": "hourly" }, { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" + }, + { + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", "key": "from", "value": "" }, { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", "key": "to", "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" } ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" } }, - "status": "Service Unavailable" + "status": "Bad Gateway" }, { "_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", @@ -94586,7 +98964,7 @@ "{{baseUrl}}" ], "path": [ - "workspaceMetrics" + "workspaceDurationMetrics" ], "query": [ { @@ -94595,48 +98973,38 @@ "value": "" }, { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", + "description": "Unit of time over which to aggregate measurements.", "key": "aggregation", "value": "hourly" }, { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" + }, + { + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", "key": "from", "value": "" }, { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", "key": "to", "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" } ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" } }, - "status": "Unsupported Media Type" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 405, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -94645,7 +99013,7 @@ "{{baseUrl}}" ], "path": [ - "workspaceMetrics" + "workspaceDurationMetrics" ], "query": [ { @@ -94654,40 +99022,30 @@ "value": "" }, { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", + "description": "Unit of time over which to aggregate measurements.", "key": "aggregation", "value": "hourly" }, { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" + }, + { + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", "key": "from", "value": "" }, { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", "key": "to", "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" } ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" } }, - "status": "Bad Request" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", @@ -94704,7 +99062,7 @@ "{{baseUrl}}" ], "path": [ - "workspaceMetrics" + "workspaceDurationMetrics" ], "query": [ { @@ -94713,37 +99071,27 @@ "value": "" }, { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", + "description": "Unit of time over which to aggregate measurements.", "key": "aggregation", "value": "hourly" }, { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" + }, + { + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", "key": "from", "value": "" }, { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", "key": "to", "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" } ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" } }, "status": "Precondition Required" @@ -94751,10 +99099,10 @@ { "_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": "GET", @@ -94763,7 +99111,7 @@ "{{baseUrl}}" ], "path": [ - "workspaceMetrics" + "workspaceDurationMetrics" ], "query": [ { @@ -94772,40 +99120,30 @@ "value": "" }, { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", + "description": "Unit of time over which to aggregate measurements.", "key": "aggregation", "value": "hourly" }, { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" + }, + { + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", "key": "from", "value": "" }, { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", "key": "to", "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" } ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" } }, - "status": "Unauthorized" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -94822,7 +99160,7 @@ "{{baseUrl}}" ], "path": [ - "workspaceMetrics" + "workspaceDurationMetrics" ], "query": [ { @@ -94831,37 +99169,27 @@ "value": "" }, { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", + "description": "Unit of time over which to aggregate measurements.", "key": "aggregation", "value": "hourly" }, { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" + }, + { + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", "key": "from", "value": "" }, { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", "key": "to", "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" } ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" } }, "status": "Too Many Requests" @@ -94881,7 +99209,7 @@ "{{baseUrl}}" ], "path": [ - "workspaceMetrics" + "workspaceDurationMetrics" ], "query": [ { @@ -94890,57 +99218,57 @@ "value": "" }, { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", + "description": "Unit of time over which to aggregate measurements.", "key": "aggregation", "value": "hourly" }, { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" + }, + { + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", "key": "from", "value": "" }, { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", "key": "to", "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" } ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" } }, "status": "Gone" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "_postman_previewlanguage": "json", + "body": "{\n \"workspaceId\": \"\",\n \"aggregation\": \"daily\",\n \"measurement\": \"timeBooked\",\n \"from\": \"\",\n \"to\": \"\",\n \"unit\": \"\",\n \"items\": [\n {\n \"start\": \"\",\n \"end\": \"\",\n \"duration\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\",\n \"duration\": \"\"\n }\n ]\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": [ "{{baseUrl}}" ], "path": [ - "workspaceMetrics" + "workspaceDurationMetrics" ], "query": [ { @@ -94949,41 +99277,216 @@ "value": "" }, { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", + "description": "Unit of time over which to aggregate measurements.", "key": "aggregation", "value": "hourly" }, { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", + "description": "The measurement to return duration for.", + "key": "measurement", + "value": "timeUsed" + }, + { + "description": "Include data points after a specific date and time (ISO 8601 timestamp).", "key": "from", "value": "" }, { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", + "description": "Include data points before a specific date and time (ISO 8601 timestamp).", "key": "to", "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" } ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + } + }, + "status": "OK" + } + ] + } + ], + "name": "Workspace Metrics" + }, + { + "item": [ + { + "name": "Get Group Schema", + "request": { + "description": "This API allows the service client to get all the `Group` schemas information from CI.\n\n**Authorization:**\n\nOAuth token rendered by Identity Broker.\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:organizations_rw`\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "Schemas", + "SCIM2", + "Group" + ], + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + } + }, + "response": [ + { + "_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": [ + "Schemas", + "SCIM2", + "Group" + ], + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + } + }, + "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": [ + "Schemas", + "SCIM2", + "Group" + ], + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + } + }, + "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": [ + "Schemas", + "SCIM2", + "Group" + ], + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + } + }, + "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": [ + "Schemas", + "SCIM2", + "Group" + ], + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + } + }, + "status": "Unsupported Media Type" + }, + { + "_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": [ + "Schemas", + "SCIM2", + "Group" + ], + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" } }, "status": "Internal Server Error" }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"urn:ietf:params:scim:schemas:core:2.0:Group\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"length\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"User\",\n \"Group\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"email\",\n \"qq\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"external\",\n \"User\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"ciRole\",\n \"Everyone\"\n ]\n }\n ],\n \"size\": \"\",\n \"canonicalValues\": [\n \"disabled\",\n \"BROADWORKS\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"length\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"external\",\n \"Machine\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"skype\",\n \"SCIM\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"Machine\",\n \"Group\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"room\",\n \"other\"\n ]\n }\n ],\n \"size\": \"\",\n \"canonicalValues\": [\n \"fax\",\n \"google\"\n ]\n }\n ]\n },\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"length\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"User\",\n \"Group\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"gtalk\",\n \"calling_service\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"external\",\n \"Group\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"personal\",\n \"resizable\"\n ]\n }\n ],\n \"size\": \"\",\n \"canonicalValues\": [\n \"transient\",\n \"distribution\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"length\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"Group\",\n \"Group\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"other\",\n \"msn\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"User\",\n \"User\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"work\",\n \"AAD\"\n ]\n }\n ],\n \"size\": \"\",\n \"canonicalValues\": [\n \"phone\",\n \"other\"\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": [ + "Schemas", + "SCIM2", + "Group" + ], + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + } + }, + "status": "OK" + }, { "_postman_previewlanguage": "text", "body": null, @@ -94999,46 +99502,11 @@ "{{baseUrl}}" ], "path": [ - "workspaceMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", - "key": "from", - "value": "" - }, - { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", - "key": "to", - "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" - } + "Schemas", + "SCIM2", + "Group" ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" } }, "status": "Gateway Timeout" @@ -95058,57 +99526,70 @@ "{{baseUrl}}" ], "path": [ - "workspaceMetrics" + "Schemas", + "SCIM2", + "Group" ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", - "key": "from", - "value": "" - }, - { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", - "key": "to", - "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" - } + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + } + }, + "status": "Bad Gateway" + }, + { + "_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": [ + "Schemas", + "SCIM2", + "Group" + ], + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + } + }, + "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}}" ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + "path": [ + "Schemas", + "SCIM2", + "Group" + ], + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" } }, - "status": "Bad Gateway" + "status": "Forbidden" }, { "_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", @@ -95117,57 +99598,22 @@ "{{baseUrl}}" ], "path": [ - "workspaceMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", - "key": "from", - "value": "" - }, - { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", - "key": "to", - "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" - } + "Schemas", + "SCIM2", + "Group" ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Service Unavailable" }, { "_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", @@ -95176,57 +99622,22 @@ "{{baseUrl}}" ], "path": [ - "workspaceMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", - "key": "from", - "value": "" - }, - { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", - "key": "to", - "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" - } + "Schemas", + "SCIM2", + "Group" ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" } }, - "status": "Not Found" + "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", @@ -95235,118 +99646,38 @@ "{{baseUrl}}" ], "path": [ - "workspaceMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", - "key": "from", - "value": "" - }, - { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", - "key": "to", - "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" - } + "Schemas", + "SCIM2", + "Group" ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" } }, - "status": "Forbidden" + "status": "Precondition Required" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"workspaceId\": \"\",\n \"metricName\": \"peopleCount\",\n \"aggregation\": \"hourly\",\n \"from\": \"\",\n \"to\": \"\",\n \"unit\": \"fahrenheit\",\n \"sortBy\": \"newestFirst\",\n \"items\": [\n \"\",\n \"\"\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 404, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", - "key": "from", - "value": "" - }, - { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", - "key": "to", - "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" - } + "Schemas", + "SCIM2", + "Group" ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" } }, - "status": "OK" + "status": "Not Found" }, { "_postman_previewlanguage": "text", @@ -95363,56 +99694,45 @@ "{{baseUrl}}" ], "path": [ - "workspaceMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "The type of data to extract.", - "key": "metricName", - "value": "peopleCount" - }, - { - "description": "Time unit over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "List only data points after a specific date and time (ISO 8601 timestamp)", - "key": "from", - "value": "" - }, - { - "description": "List data points before a specific date and time (ISO 8601 timestamp)", - "key": "to", - "value": "" - }, - { - "description": "Output data unit (only a valid parameter if `metricName` is `temperature`).", - "key": "unit", - "value": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names." - }, - { - "description": "Sort results.", - "key": "sortBy", - "value": "newestFirst" - } + "Schemas", + "SCIM2", + "Group" ], - "raw": "{{baseUrl}}/workspaceMetrics?workspaceId=&metricName=peopleCount&aggregation=hourly&from=&to=&unit=Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.&sortBy=newestFirst" + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" } }, "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": [ + "Schemas", + "SCIM2", + "Group" + ], + "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" } ] }, { - "name": "Workspace Duration Metrics", + "name": "Get User Schema", "request": { - "description": "Get metrics for how much time a workspace has been in the state given by the `measurement` parameter.\n\nFor example, if the measurement is `timeBooked` then the duration for which the workspace has been booked is returned. The `workspaceId` parameter indicates which workspace to fetch metrics for. If no `measurement` is given, the default value is `timeUsed`.\n\n* When executing a query, the result bucket start times will default to the start of an hour or a day, depending on\nthe aggregation interval. However, the buckets will not contain data from outside the requested time range. For example, when\npassing `from=2020-10-21T10:34:56.000Z` and `aggregation=hourly`, the first output bucket would start at `2020-10-21T10:00:00.000Z`,\nbut the bucket would only aggregate data timestamped after `10:34:56`.\n\n* For aggregation mode `hourly`, the maximum time span is 48 hours. For aggregation mode `daily`, the maximum\ntime span is 30 days.", + "description": "This API allows the service client to get all the `User` schemas information from CI.\n\n**Authorization:**\n\nOAuth token rendered by Identity Broker.\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:organizations_rw`\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`", "header": [ { "key": "Accept", @@ -95425,46 +99745,21 @@ "{{baseUrl}}" ], "path": [ - "workspaceDurationMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } + "Schemas", + "SCIM2", + "User" ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "raw": "{{baseUrl}}/Schemas/SCIM2/User" } }, "response": [ { "_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", @@ -95473,47 +99768,22 @@ "{{baseUrl}}" ], "path": [ - "workspaceDurationMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } + "Schemas", + "SCIM2", + "User" ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "raw": "{{baseUrl}}/Schemas/SCIM2/User" } }, - "status": "Unauthorized" + "status": "Unsupported Media Type" }, { "_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": { "header": [], "method": "GET", @@ -95522,145 +99792,56 @@ "{{baseUrl}}" ], "path": [ - "workspaceDurationMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } + "Schemas", + "SCIM2", + "User" ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "raw": "{{baseUrl}}/Schemas/SCIM2/User" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Gateway" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 415, + "_postman_previewlanguage": "json", + "body": "{\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attributes\": [\n {\n \"referenceTypes\": \"Group\",\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"canonicalValues\": [\n \"id_device_admin\"\n ],\n \"uniqueness\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"external\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"cloud\"\n ]\n }\n ],\n \"size\": \"\",\n \"length\": \"\"\n }\n ]\n },\n \"urn:ietf:params:scim:schemas:core:2.0:User\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attributes\": [\n {\n \"referenceTypes\": \"Group\",\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"canonicalValues\": [\n \"flat_static\"\n ],\n \"uniqueness\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"User\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"compliance\"\n ]\n }\n ],\n \"size\": \"\",\n \"length\": \"\"\n }\n ]\n },\n \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attributes\": [\n {\n \"referenceTypes\": \"external\",\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"canonicalValues\": [\n \"AAD\"\n ],\n \"uniqueness\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"User\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"OKTA\"\n ]\n }\n ],\n \"size\": \"\",\n \"length\": \"\"\n }\n ]\n }\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.", - "originalRequest": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "workspaceDurationMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } - ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "header": [ + { + "key": "Content-Type", + "value": "application/json" } - }, - "status": "Unsupported Media Type" - }, - { - "_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": "OK", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceDurationMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } + "Schemas", + "SCIM2", + "User" ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "raw": "{{baseUrl}}/Schemas/SCIM2/User" } }, - "status": "Internal Server Error" + "status": "OK" }, { "_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": { "header": [], "method": "GET", @@ -95669,47 +99850,22 @@ "{{baseUrl}}" ], "path": [ - "workspaceDurationMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } + "Schemas", + "SCIM2", + "User" ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "raw": "{{baseUrl}}/Schemas/SCIM2/User" } }, - "status": "Service Unavailable" + "status": "Bad Request" }, { "_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", @@ -95718,47 +99874,22 @@ "{{baseUrl}}" ], "path": [ - "workspaceDurationMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } + "Schemas", + "SCIM2", + "User" ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "raw": "{{baseUrl}}/Schemas/SCIM2/User" } }, - "status": "Conflict" + "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", @@ -95767,47 +99898,22 @@ "{{baseUrl}}" ], "path": [ - "workspaceDurationMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } + "Schemas", + "SCIM2", + "User" ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "raw": "{{baseUrl}}/Schemas/SCIM2/User" } }, - "status": "Forbidden" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 410, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -95816,47 +99922,22 @@ "{{baseUrl}}" ], "path": [ - "workspaceDurationMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } + "Schemas", + "SCIM2", + "User" ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "raw": "{{baseUrl}}/Schemas/SCIM2/User" } }, - "status": "Bad Request" + "status": "Gone" }, { "_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": { "header": [], "method": "GET", @@ -95865,47 +99946,22 @@ "{{baseUrl}}" ], "path": [ - "workspaceDurationMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } + "Schemas", + "SCIM2", + "User" ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "raw": "{{baseUrl}}/Schemas/SCIM2/User" } }, - "status": "Bad Gateway" + "status": "Not Found" }, { "_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": { "header": [], "method": "GET", @@ -95914,47 +99970,22 @@ "{{baseUrl}}" ], "path": [ - "workspaceDurationMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } + "Schemas", + "SCIM2", + "User" ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "raw": "{{baseUrl}}/Schemas/SCIM2/User" } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 423, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "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", @@ -95963,47 +99994,22 @@ "{{baseUrl}}" ], "path": [ - "workspaceDurationMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } + "Schemas", + "SCIM2", + "User" ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "raw": "{{baseUrl}}/Schemas/SCIM2/User" } }, - "status": "Method Not Allowed" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 409, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "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", @@ -96012,39 +100018,38 @@ "{{baseUrl}}" ], "path": [ - "workspaceDurationMetrics" + "Schemas", + "SCIM2", + "User" ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } + "raw": "{{baseUrl}}/Schemas/SCIM2/User" + } + }, + "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).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "path": [ + "Schemas", + "SCIM2", + "User" + ], + "raw": "{{baseUrl}}/Schemas/SCIM2/User" } }, - "status": "Precondition Required" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -96061,36 +100066,11 @@ "{{baseUrl}}" ], "path": [ - "workspaceDurationMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } + "Schemas", + "SCIM2", + "User" ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "raw": "{{baseUrl}}/Schemas/SCIM2/User" } }, "status": "Gateway Timeout" @@ -96098,10 +100078,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", @@ -96110,47 +100090,22 @@ "{{baseUrl}}" ], "path": [ - "workspaceDurationMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } + "Schemas", + "SCIM2", + "User" ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "raw": "{{baseUrl}}/Schemas/SCIM2/User" } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_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", @@ -96159,110 +100114,45 @@ "{{baseUrl}}" ], "path": [ - "workspaceDurationMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } + "Schemas", + "SCIM2", + "User" ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "raw": "{{baseUrl}}/Schemas/SCIM2/User" } }, - "status": "Gone" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"workspaceId\": \"\",\n \"aggregation\": \"daily\",\n \"measurement\": \"timeBooked\",\n \"from\": \"\",\n \"to\": \"\",\n \"unit\": \"\",\n \"items\": [\n {\n \"start\": \"\",\n \"end\": \"\",\n \"duration\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\",\n \"duration\": \"\"\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: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "workspaceDurationMetrics" - ], - "query": [ - { - "description": "ID of the workspace to get metrics for.", - "key": "workspaceId", - "value": "" - }, - { - "description": "Unit of time over which to aggregate measurements.", - "key": "aggregation", - "value": "hourly" - }, - { - "description": "The measurement to return duration for.", - "key": "measurement", - "value": "timeUsed" - }, - { - "description": "Include data points after a specific date and time (ISO 8601 timestamp).", - "key": "from", - "value": "" - }, - { - "description": "Include data points before a specific date and time (ISO 8601 timestamp).", - "key": "to", - "value": "" - } + "Schemas", + "SCIM2", + "User" ], - "raw": "{{baseUrl}}/workspaceDurationMetrics?workspaceId=&aggregation=hourly&measurement=timeUsed&from=&to=" + "raw": "{{baseUrl}}/Schemas/SCIM2/User" } }, - "status": "OK" + "status": "Forbidden" } - ] - } - ], - "name": "Workspace Metrics" - }, - { - "item": [ + ] + }, { - "name": "Get Group Schema", + "name": "Get Schema using Group Schema ID", "request": { - "description": "This API allows the service client to get all the `Group` schemas information from CI.\n\n**Authorization:**\n\nOAuth token rendered by Identity Broker.\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:organizations_rw`\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`", + "description": "This API allows the service client to get the Group/User Schema using `Schema Id` from CI.\n\nExample:\n\n- `urn:ietf:params:scim:schemas:core:2.0:Group` is one of the `Group Schema Id`. Using this particular ID, we can fetch all information related to it.\n\n- `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` is one of the `User Schema Id`. Using this particular ID, we can fetch all information related to it.\n\n**Authorization:**\n\nOAuth token rendered by Identity Broker.\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:organizations_rw`\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`", "header": [ { "key": "Accept", @@ -96277,19 +100167,26 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId", + "value": "" + } + ] } }, "response": [ { "_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", @@ -96300,20 +100197,26 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId" + } + ] } }, - "status": "Too Many Requests" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 405, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -96324,20 +100227,26 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId" + } + ] } }, - "status": "Bad Request" + "status": "Method Not Allowed" }, { "_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", @@ -96348,20 +100257,26 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId" + } + ] } }, - "status": "Unauthorized" + "status": "Unsupported Media Type" }, { "_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": { "header": [], "method": "GET", @@ -96372,20 +100287,26 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId" + } + ] } }, - "status": "Unsupported Media Type" + "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": { "header": [], "method": "GET", @@ -96396,32 +100317,28 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId" + } + ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"urn:ietf:params:scim:schemas:core:2.0:Group\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"length\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"User\",\n \"Group\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"email\",\n \"qq\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"external\",\n \"User\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"ciRole\",\n \"Everyone\"\n ]\n }\n ],\n \"size\": \"\",\n \"canonicalValues\": [\n \"disabled\",\n \"BROADWORKS\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"length\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"external\",\n \"Machine\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"skype\",\n \"SCIM\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"Machine\",\n \"Group\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"room\",\n \"other\"\n ]\n }\n ],\n \"size\": \"\",\n \"canonicalValues\": [\n \"fax\",\n \"google\"\n ]\n }\n ]\n },\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"length\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"User\",\n \"Group\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"gtalk\",\n \"calling_service\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"external\",\n \"Group\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"personal\",\n \"resizable\"\n ]\n }\n ],\n \"size\": \"\",\n \"canonicalValues\": [\n \"transient\",\n \"distribution\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"length\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"Group\",\n \"Group\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"other\",\n \"msn\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"User\",\n \"User\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"work\",\n \"AAD\"\n ]\n }\n ],\n \"size\": \"\",\n \"canonicalValues\": [\n \"phone\",\n \"other\"\n ]\n }\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: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -96430,20 +100347,26 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId" + } + ] } }, - "status": "OK" + "status": "Forbidden" }, { "_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", @@ -96454,20 +100377,26 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId" + } + ] } }, - "status": "Gateway Timeout" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 428, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -96478,20 +100407,26 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId" + } + ] } }, - "status": "Bad Gateway" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 400, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], "method": "GET", @@ -96502,20 +100437,26 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId" + } + ] } }, - "status": "Gone" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 423, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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", @@ -96526,20 +100467,26 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId" + } + ] } }, - "status": "Forbidden" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 502, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -96550,20 +100497,26 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId" + } + ] } }, - "status": "Service Unavailable" + "status": "Bad Gateway" }, { "_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", @@ -96574,22 +100527,38 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId" + } + ] } }, - "status": "Method Not Allowed" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 428, + "_postman_previewlanguage": "json", + "body": "{\n \"urn:ietf:params:scim:schemas:core:2.0:Group\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"length\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"User\",\n \"external\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"personal\",\n \"id_full_admin\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"external\",\n \"Group\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"alternate1\",\n \"mobile\"\n ]\n }\n ],\n \"size\": \"\",\n \"canonicalValues\": [\n \"marked_deleted\",\n \"id_device_admin\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"length\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"User\",\n \"external\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"disabled\",\n \"alternate2\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"external\",\n \"external\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"xmpp\",\n \"cco\"\n ]\n }\n ],\n \"size\": \"\",\n \"canonicalValues\": [\n \"distribution\",\n \"policy\"\n ]\n }\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": [ @@ -96598,20 +100567,26 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId" + } + ] } }, - "status": "Precondition Required" + "status": "OK" }, { "_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": "GET", @@ -96622,20 +100597,26 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId" + } + ] } }, - "status": "Not Found" + "status": "Gone" }, { "_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": "GET", @@ -96646,20 +100627,26 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId" + } + ] } }, - "status": "Conflict" + "status": "Internal Server Error" }, { "_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", @@ -96670,312 +100657,410 @@ "path": [ "Schemas", "SCIM2", - "Group" + ":schemaId" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/Group" + "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "variable": [ + { + "description": "The Schema Id of Group/User Schema", + "key": "schemaId" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unauthorized" } ] - }, + } + ], + "name": "SCIM 2 Schemas" + }, + { + "item": [ { - "name": "Get User Schema", + "name": "Initiate Bulk Activation Email Resend Job", "request": { - "description": "This API allows the service client to get all the `User` schemas information from CI.\n\n**Authorization:**\n\nOAuth token rendered by Identity Broker.\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:organizations_rw`\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`", + "description": "Initiate a bulk activation email resend job that sends an activation email to all eligible users in an organization. Only a single instance of the job can be running for an organization.\n\nRequires a full or user administrator auth token with a scope of `spark-admin:people_write`.", "header": [ { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId", + "value": "" + } + ] } }, "response": [ { "_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": { "header": [], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId" + } + ] } }, - "status": "Unsupported Media Type" + "status": "Gateway Timeout" }, { "_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": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId" + } + ] } }, - "status": "Bad Gateway" + "status": "Conflict" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attributes\": [\n {\n \"referenceTypes\": \"Group\",\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"canonicalValues\": [\n \"id_device_admin\"\n ],\n \"uniqueness\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"external\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"cloud\"\n ]\n }\n ],\n \"size\": \"\",\n \"length\": \"\"\n }\n ]\n },\n \"urn:ietf:params:scim:schemas:core:2.0:User\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attributes\": [\n {\n \"referenceTypes\": \"Group\",\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"canonicalValues\": [\n \"flat_static\"\n ],\n \"uniqueness\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"User\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"compliance\"\n ]\n }\n ],\n \"size\": \"\",\n \"length\": \"\"\n }\n ]\n },\n \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attributes\": [\n {\n \"referenceTypes\": \"external\",\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"canonicalValues\": [\n \"AAD\"\n ],\n \"uniqueness\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"User\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"OKTA\"\n ]\n }\n ],\n \"size\": \"\",\n \"length\": \"\"\n }\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" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId" + } + ] } }, - "status": "OK" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 405, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId" + } + ] } }, - "status": "Bad Request" + "status": "Method Not Allowed" }, { "_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", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId" + } + ] } }, - "status": "Method Not Allowed" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 502, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId" + } + ] } }, - "status": "Precondition Required" + "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": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId" + } + ] } }, - "status": "Gone" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId" + } + ] } }, - "status": "Not Found" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 403, "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": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId" + } + ] } }, - "status": "Too Many Requests" + "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": { "header": [], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 429, "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": "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", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId" + } + ] } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", @@ -96986,17 +101071,25 @@ "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", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId" + } + ] } }, "status": "Internal Server Error" @@ -97004,105 +101097,147 @@ { "_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", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId" + } + ] } }, - "status": "Gateway Timeout" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, + "_postman_previewlanguage": "json", + "body": "{\n \"name\": \"\",\n \"id\": \"\",\n \"trackingId\": \"\",\n \"sourceUserId\": \"\",\n \"sourceCustomerId\": \"\",\n \"targetCustomerId\": \"\",\n \"instanceId\": \"\",\n \"latestExecutionStatus\": \"STARTING\",\n \"counts\": {\n \"userResendInviteSent\": \"\",\n \"userResendInviteFailed\": \"\",\n \"userResendInviteSkipped\": \"\",\n \"totalUsers\": \"\"\n },\n \"jobExecutionStatus\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"COMPLETED\",\n \"exitCode\": \"COMPLETED\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"STOPPING\",\n \"exitCode\": \"STARTING\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n }\n ],\n \"latestExecutionExitCode\": \"FAILED\",\n \"allowAdminInviteEmails\": \"\"\n}", + "code": 202, "cookie": [], - "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Accepted", "originalRequest": { - "header": [], - "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId" + } + ] } }, - "status": "Unauthorized" + "status": "Accepted" }, { "_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", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId" + } + ] } }, - "status": "Service Unavailable" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 400, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - "User" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/User" + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "variable": [ + { + "description": "Initiate job for this organization.", + "key": "orgId" + } + ] } }, - "status": "Forbidden" + "status": "Bad Request" } ] }, { - "name": "Get Schema using Group Schema ID", + "name": "Get Bulk Activation Email Resend Job Status", "request": { - "description": "This API allows the service client to get the Group/User Schema using `Schema Id` from CI.\n\nExample:\n\n- `urn:ietf:params:scim:schemas:core:2.0:Group` is one of the `Group Schema Id`. Using this particular ID, we can fetch all information related to it.\n\n- `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` is one of the `User Schema Id`. Using this particular ID, we can fetch all information related to it.\n\n**Authorization:**\n\nOAuth token rendered by Identity Broker.\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:organizations_rw`\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`", + "description": "Get the details of an activation email resend job by its job ID.\n\nRequires a full or user administrator auth token with a scope of `spark-admin:people_write` or read-only administrator auth token with a scope of `spark-admin:people_read`.", "header": [ { "key": "Accept", @@ -97115,15 +101250,24 @@ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId", + "description": "Check job status for this organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId", "value": "" } ] @@ -97133,10 +101277,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 502, "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 Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -97145,58 +101289,84 @@ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId" + "description": "Check job status for this organization.", + "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Gateway Timeout" + "status": "Bad Gateway" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 405, + "_postman_previewlanguage": "json", + "body": "{\n \"name\": \"\",\n \"id\": \"\",\n \"trackingId\": \"\",\n \"sourceUserId\": \"\",\n \"sourceCustomerId\": \"\",\n \"targetCustomerId\": \"\",\n \"instanceId\": \"\",\n \"latestExecutionStatus\": \"STARTING\",\n \"counts\": {\n \"userResendInviteSent\": \"\",\n \"userResendInviteFailed\": \"\",\n \"userResendInviteSkipped\": \"\",\n \"totalUsers\": \"\"\n },\n \"jobExecutionStatus\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"COMPLETED\",\n \"exitCode\": \"COMPLETED\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"STOPPING\",\n \"exitCode\": \"STARTING\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n }\n ],\n \"latestExecutionExitCode\": \"FAILED\",\n \"allowAdminInviteEmails\": \"\"\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": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId" + "description": "Check job status for this organization.", + "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Method Not Allowed" + "status": "OK" }, { "_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": "GET", @@ -97205,28 +101375,36 @@ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId" + "description": "Check job status for this organization.", + "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Unsupported Media Type" + "status": "Unauthorized" }, { "_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", @@ -97235,28 +101413,36 @@ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId" + "description": "Check job status for this organization.", + "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Conflict" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 400, "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": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], "method": "GET", @@ -97265,20 +101451,28 @@ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId" + "description": "Check job status for this organization.", + "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Too Many Requests" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", @@ -97295,15 +101489,23 @@ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId" + "description": "Check job status for this organization.", + "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } @@ -97313,10 +101515,10 @@ { "_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", @@ -97325,28 +101527,36 @@ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId" + "description": "Check job status for this organization.", + "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Not Found" + "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", @@ -97355,28 +101565,36 @@ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId" + "description": "Check job status for this organization.", + "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Precondition Required" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 415, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -97385,28 +101603,36 @@ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId" + "description": "Check job status for this organization.", + "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Bad Request" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 404, "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": "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", @@ -97415,28 +101641,36 @@ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId" + "description": "Check job status for this organization.", + "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "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", @@ -97445,28 +101679,36 @@ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId" + "description": "Check job status for this organization.", + "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Bad Gateway" + "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": { "header": [], "method": "GET", @@ -97475,68 +101717,74 @@ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId" + "description": "Check job status for this organization.", + "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Service Unavailable" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"urn:ietf:params:scim:schemas:core:2.0:Group\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"length\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"User\",\n \"external\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"personal\",\n \"id_full_admin\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"external\",\n \"Group\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"alternate1\",\n \"mobile\"\n ]\n }\n ],\n \"size\": \"\",\n \"canonicalValues\": [\n \"marked_deleted\",\n \"id_device_admin\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"length\": \"\",\n \"subAttributes\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"User\",\n \"external\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"disabled\",\n \"alternate2\"\n ]\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"referenceTypes\": [\n \"external\",\n \"external\"\n ],\n \"multiValued\": \"\",\n \"description\": \"\",\n \"required\": \"\",\n \"caseExact\": \"\",\n \"mutability\": \"\",\n \"returned\": \"\",\n \"uniqueness\": \"\",\n \"canonicalValues\": [\n \"xmpp\",\n \"cco\"\n ]\n }\n ],\n \"size\": \"\",\n \"canonicalValues\": [\n \"distribution\",\n \"policy\"\n ]\n }\n ]\n }\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 410, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId" + "description": "Check job status for this organization.", + "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "OK" + "status": "Gone" }, { "_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": "GET", @@ -97545,28 +101793,36 @@ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId" + "description": "Check job status for this organization.", + "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Gone" + "status": "Gateway Timeout" }, { "_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": "GET", @@ -97575,28 +101831,36 @@ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId" + "description": "Check job status for this organization.", + "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_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": { "header": [], "method": "GET", @@ -97605,39 +101869,42 @@ "{{baseUrl}}" ], "path": [ - "Schemas", - "SCIM2", - ":schemaId" + "identity", + "organizations", + ":orgId", + "jobs", + "sendActivationEmails", + ":jobId", + "status" ], - "raw": "{{baseUrl}}/Schemas/SCIM2/:schemaId", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", "variable": [ { - "description": "The Schema Id of Group/User Schema", - "key": "schemaId" + "description": "Check job status for this organization.", + "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" } ] - } - ], - "name": "SCIM 2 Schemas" - }, - { - "item": [ + }, { - "name": "Initiate Bulk Activation Email Resend Job", + "name": "Get Bulk Activation Email Resend Job Errors", "request": { - "description": "Initiate a bulk activation email resend job that sends an activation email to all eligible users in an organization. Only a single instance of the job can be running for an organization.\n\nRequires a full or user administrator auth token with a scope of `spark-admin:people_write`.", + "description": "Get errors of an activation email resend job by its job ID.\n\nRequires a full or user administrator auth token with a scope of `spark-admin:people_write` or read-only administrator auth token with a scope of `spark-admin:people_read`.", "header": [ { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -97647,14 +101914,28 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId", "value": "" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId", + "value": "" } ] } @@ -97663,13 +101944,13 @@ { "_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": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -97679,29 +101960,42 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Gateway Timeout" + "status": "Bad Request" }, { "_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": { "header": [], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -97711,18 +102005,31 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Conflict" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", @@ -97733,7 +102040,7 @@ "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -97743,13 +102050,26 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } @@ -97757,15 +102077,34 @@ "status": "Service Unavailable" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 405, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"itemNumber\": \"\",\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\",\n \"code\": \"\",\n \"locationId\": \"\"\n },\n {\n \"description\": \"\",\n \"code\": \"\",\n \"locationId\": \"\"\n }\n ]\n }\n },\n {\n \"itemNumber\": \"\",\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\",\n \"code\": \"\",\n \"locationId\": \"\"\n },\n {\n \"description\": \"\",\n \"code\": \"\",\n \"locationId\": \"\"\n }\n ]\n }\n }\n ]\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" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -97775,29 +102114,42 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Method Not Allowed" + "status": "OK" }, { "_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": { "header": [], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -97807,29 +102159,42 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Precondition Required" + "status": "Unauthorized" }, { "_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": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -97839,29 +102204,42 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Bad Gateway" + "status": "Conflict" }, { "_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": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -97871,29 +102249,42 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gone" }, { "_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": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -97903,29 +102294,42 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Unsupported Media Type" + "status": "Too Many Requests" }, { "_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": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -97935,29 +102339,42 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_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": { "header": [], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -97967,29 +102384,42 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" + ], + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Gone" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 403, "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": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -97999,29 +102429,42 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_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": { "header": [], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -98031,29 +102474,42 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Internal Server Error" + "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": { "header": [], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -98063,39 +102519,42 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Not Found" + "status": "Bad Gateway" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"name\": \"\",\n \"id\": \"\",\n \"trackingId\": \"\",\n \"sourceUserId\": \"\",\n \"sourceCustomerId\": \"\",\n \"targetCustomerId\": \"\",\n \"instanceId\": \"\",\n \"latestExecutionStatus\": \"STARTING\",\n \"counts\": {\n \"userResendInviteSent\": \"\",\n \"userResendInviteFailed\": \"\",\n \"userResendInviteSkipped\": \"\",\n \"totalUsers\": \"\"\n },\n \"jobExecutionStatus\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"COMPLETED\",\n \"exitCode\": \"COMPLETED\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"STOPPING\",\n \"exitCode\": \"STARTING\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n }\n ],\n \"latestExecutionExitCode\": \"FAILED\",\n \"allowAdminInviteEmails\": \"\"\n}", - "code": 202, + "_postman_previewlanguage": "text", + "body": null, + "code": 428, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Accepted", + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -98105,29 +102564,42 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Accepted" + "status": "Precondition Required" }, { "_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": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -98137,29 +102609,42 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Unauthorized" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 415, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -98169,55 +102654,79 @@ "organizations", ":orgId", "jobs", - "sendActivationEmails" + "sendActivationEmails", + ":jobId", + "errors" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails", + "query": [ + { + "description": "Limit the maximum number of errors in the response.", + "key": "max", + "value": "50" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", "variable": [ { - "description": "Initiate job for this organization.", + "description": "Check job status for this organization.", "key": "orgId" + }, + { + "description": "Retrieve job status for this `jobId`.", + "key": "jobId" } ] } }, - "status": "Bad Request" + "status": "Unsupported Media Type" } ] - }, + } + ], + "name": "Send Activation Email" + }, + { + "description": "Operations for managing Service App access tokens", + "item": [ { - "name": "Get Bulk Activation Email Resend Job Status", + "name": "Create Service App Access Token", "request": { - "description": "Get the details of an activation email resend job by its job ID.\n\nRequires a full or user administrator auth token with a scope of `spark-admin:people_write` or read-only administrator auth token with a scope of `spark-admin:people_read`.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"targetOrgId\": \"\"\n}" + }, + "description": "Retrieves an organization specific token pair for an already authorized Service App. Service Apps use machine accounts to make API calls on behalf of an organization, independent of individual user life cycles.\n\nThis endpoint allows you to programmatically retrieve access and refresh tokens after a Full Admin has authorized your Service App in Control Hub.\n\nTo call this endpoint, you need an integration with the spark:applications_token scope.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "applications", + ":applicationId", + "token" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", + "raw": "{{baseUrl}}/applications/:applicationId/token", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId", - "value": "" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId", + "description": "The unique identifier of the Service App", + "key": "applicationId", "value": "" } ] @@ -98225,46 +102734,63 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 502, + "_postman_previewlanguage": "json", + "body": "{\n \"message\": \"\",\n \"trackingId\": \"\",\n \"errors\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n}", + "code": 403, "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": "Forbidden - Insufficient permissions or Service App not authorized by Full Admin in Control Hub", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"targetOrgId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "applications", + ":applicationId", + "token" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", + "raw": "{{baseUrl}}/applications/:applicationId/token", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier of the Service App", + "key": "applicationId", + "value": "" } ] } }, - "status": "Bad Gateway" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"name\": \"\",\n \"id\": \"\",\n \"trackingId\": \"\",\n \"sourceUserId\": \"\",\n \"sourceCustomerId\": \"\",\n \"targetCustomerId\": \"\",\n \"instanceId\": \"\",\n \"latestExecutionStatus\": \"STARTING\",\n \"counts\": {\n \"userResendInviteSent\": \"\",\n \"userResendInviteFailed\": \"\",\n \"userResendInviteSkipped\": \"\",\n \"totalUsers\": \"\"\n },\n \"jobExecutionStatus\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"COMPLETED\",\n \"exitCode\": \"COMPLETED\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"STOPPING\",\n \"exitCode\": \"STARTING\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n }\n ],\n \"latestExecutionExitCode\": \"FAILED\",\n \"allowAdminInviteEmails\": \"\"\n}", + "body": "{\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"refresh_token\": \"\",\n \"refresh_token_expires_in\": \"\",\n \"token_type\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -98273,37 +102799,44 @@ "value": "application/json" } ], - "name": "OK", + "name": "Successfully created Service App access token", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"targetOrgId\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "applications", + ":applicationId", + "token" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", + "raw": "{{baseUrl}}/applications/:applicationId/token", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier of the Service App", + "key": "applicationId", + "value": "" } ] } @@ -98311,543 +102844,661 @@ "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, + "_postman_previewlanguage": "json", + "body": "{\n \"message\": \"\",\n \"trackingId\": \"\",\n \"errors\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n}", + "code": 404, "cookie": [], - "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Service App not found", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"targetOrgId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "applications", + ":applicationId", + "token" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", + "raw": "{{baseUrl}}/applications/:applicationId/token", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier of the Service App", + "key": "applicationId", + "value": "" } ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 428, + "_postman_previewlanguage": "json", + "body": "{\n \"message\": \"\",\n \"trackingId\": \"\",\n \"errors\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n}", + "code": 401, "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": "Unauthorized - Authentication required", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"targetOrgId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "applications", + ":applicationId", + "token" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", + "raw": "{{baseUrl}}/applications/:applicationId/token", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier of the Service App", + "key": "applicationId", + "value": "" } ] } }, - "status": "Precondition Required" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"message\": \"\",\n \"trackingId\": \"\",\n \"errors\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\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": "Bad request - Invalid input parameters", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"targetOrgId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", + "path": [ + "applications", + ":applicationId", + "token" + ], + "raw": "{{baseUrl}}/applications/:applicationId/token", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier of the Service App", + "key": "applicationId", + "value": "" } ] } }, "status": "Bad Request" + } + ] + } + ], + "name": "Service Apps" + }, + { + "item": [ + { + "name": "Get Live Meeting metrics categorized by Country", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, + "description": "Retrieve live meeting metrics categorized by country for a specific meeting site or for all meeting sites owned by the customer. \n\nTo retrieve live monitoring information, you must use an administrator token with the `analytics:read_all` [scope](/docs/integrations#scopes). The authenticated user must be a read-only or full administrator of the organization to which the meeting belongs and must not be an external administrator.\n\nTo use this endpoint, the org needs to be licensed for the Webex Pro Pack.\n\nA rate limit of one API call per minute applies to each customer organization", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "livemonitoring", + "liveMeetingsByCountry" + ], + "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" + } + }, + "response": [ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "livemonitoring", + "liveMeetingsByCountry" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", - "variable": [ - { - "description": "Check job status for this organization.", - "key": "orgId" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" - } - ] + "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" } }, - "status": "Forbidden" + "status": "Service Unavailable" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "livemonitoring", + "liveMeetingsByCountry" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", - "variable": [ - { - "description": "Check job status for this organization.", - "key": "orgId" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" - } - ] + "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" } }, - "status": "Method Not Allowed" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 502, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "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 \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "livemonitoring", + "liveMeetingsByCountry" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", - "variable": [ - { - "description": "Check job status for this organization.", - "key": "orgId" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" - } - ] + "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" } }, - "status": "Service Unavailable" + "status": "Bad Gateway" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "livemonitoring", + "liveMeetingsByCountry" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", - "variable": [ - { - "description": "Check job status for this organization.", - "key": "orgId" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" - } - ] + "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" } }, - "status": "Unsupported Media Type" + "status": "Bad Request" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "livemonitoring", + "liveMeetingsByCountry" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", - "variable": [ - { - "description": "Check job status for this organization.", - "key": "orgId" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" - } - ] + "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" } }, - "status": "Not Found" + "status": "Method Not Allowed" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "livemonitoring", + "liveMeetingsByCountry" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", - "variable": [ - { - "description": "Check job status for this organization.", - "key": "orgId" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" - } - ] + "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "livemonitoring", + "liveMeetingsByCountry" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", - "variable": [ - { - "description": "Check job status for this organization.", - "key": "orgId" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" - } - ] + "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 401, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "livemonitoring", + "liveMeetingsByCountry" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", - "variable": [ - { - "description": "Check job status for this organization.", - "key": "orgId" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" - } - ] + "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" } }, - "status": "Gone" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 504, + "_postman_previewlanguage": "json", + "body": "{\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"totalLiveMeetingCount\": \"\",\n \"totalLiveParticipantCount\": \"\",\n \"totalGoodQualityLiveMeetingCount\": \"\",\n \"totalGoodQualityLiveParticipantCount\": \"\",\n \"totalBadQualityMeetingCount\": \"\",\n \"totalBadQualityParticipantCount\": \"\",\n \"locations\": [\n {\n \"country\": \"\",\n \"countryLatitude\": \"\",\n \"countryLongitude\": \"\",\n \"liveMeetingCount\": \"\",\n \"liveParticipantCount\": \"\",\n \"badQualityLiveMeetingCount\": \"\",\n \"badQualityLiveParticipantCount\": \"\",\n \"goodQualityLiveMeetingCount\": \"\",\n \"goodQualityLiveParticipantCount\": \"\"\n },\n {\n \"country\": \"\",\n \"countryLatitude\": \"\",\n \"countryLongitude\": \"\",\n \"liveMeetingCount\": \"\",\n \"liveParticipantCount\": \"\",\n \"badQualityLiveMeetingCount\": \"\",\n \"badQualityLiveParticipantCount\": \"\",\n \"goodQualityLiveMeetingCount\": \"\",\n \"goodQualityLiveParticipantCount\": \"\"\n }\n ]\n}", + "code": 200, "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" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "livemonitoring", + "liveMeetingsByCountry" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", - "variable": [ - { - "description": "Check job status for this organization.", - "key": "orgId" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" - } - ] + "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" } }, - "status": "Gateway Timeout" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 429, "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": "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 \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "livemonitoring", + "liveMeetingsByCountry" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", - "variable": [ - { - "description": "Check job status for this organization.", - "key": "orgId" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" - } - ] + "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 404, "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": "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 \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "status" + "livemonitoring", + "liveMeetingsByCountry" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status", - "variable": [ - { - "description": "Check job status for this organization.", - "key": "orgId" - }, - { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" - } - ] + "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" } }, - "status": "Internal Server Error" + "status": "Not Found" } ] - }, + } + ], + "name": "Live Monitoring" + }, + { + "item": [ { - "name": "Get Bulk Activation Email Resend Job Errors", + "name": "Get Archive User", "request": { - "description": "Get errors of an activation email resend job by its job ID.\n\nRequires a full or user administrator auth token with a scope of `spark-admin:people_write` or read-only administrator auth token with a scope of `spark-admin:people_read`.", + "description": "The `useruuid` is the unique identifier of a user in the system. It is assigned when the user is created and can be retrieved through **GET Users** API.
\n\n**Authorization**\n\nOAuth token issued by the Identity Broker.\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`.\n- `identity:people_read`.\n\nThe following administrators can use this API:\n\n- `Account in the specified organization with one of the following roles: id_full_admin, id_user_admin, id_readonly_admin`.\n- `Proxy account managing the specified organization with one of the following roles: id_full_admin, id_user_admin, id_readonly_admin`.\n\n
", "header": [ { "key": "Accept", @@ -98863,28 +103514,20 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", + "description": "The unique identifier for the organization.", "key": "orgId", "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId", + "description": "The unique identifier for the user.", + "key": "useruuid", "value": "" } ] @@ -98894,10 +103537,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 410, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -98909,40 +103552,34 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier for the user.", + "key": "useruuid", + "value": "" } ] } }, - "status": "Bad Request" + "status": "Gone" }, { "_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", @@ -98954,40 +103591,34 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier for the user.", + "key": "useruuid", + "value": "" } ] } }, - "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 requested URI is invalid, or the resource (such as a user) does not exist. Also returned when the requested format is not supported for the method.", "originalRequest": { "header": [], "method": "GET", @@ -98999,61 +103630,36 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier for the user.", + "key": "useruuid", + "value": "" } ] } }, - "status": "Service Unavailable" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"itemNumber\": \"\",\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\",\n \"code\": \"\",\n \"locationId\": \"\"\n },\n {\n \"description\": \"\",\n \"code\": \"\",\n \"locationId\": \"\"\n }\n ]\n }\n },\n {\n \"itemNumber\": \"\",\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\",\n \"code\": \"\",\n \"locationId\": \"\"\n },\n {\n \"description\": \"\",\n \"code\": \"\",\n \"locationId\": \"\"\n }\n ]\n }\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 502, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" - } - ], - "name": "OK", + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server. Try again later.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -99063,40 +103669,34 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier for the user.", + "key": "useruuid", + "value": "" } ] } }, - "status": "OK" + "status": "Bad Gateway" }, { "_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 processed. An accompanying error message explains the issue.", "originalRequest": { "header": [], "method": "GET", @@ -99108,40 +103708,34 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier for the user.", + "key": "useruuid", + "value": "" } ] } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 401, "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": "Unauthorized: Authentication credentials were missing or invalid.", "originalRequest": { "header": [], "method": "GET", @@ -99153,40 +103747,34 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier for the user.", + "key": "useruuid", + "value": "" } ] } }, - "status": "Conflict" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 415, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Unsupported Media Type: The request was made without specifying a media type or used a media type that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -99198,40 +103786,34 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier for the user.", + "key": "useruuid", + "value": "" } ] } }, - "status": "Gone" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 405, "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": "Method Not Allowed: The request was made using an unsupported HTTP method.", "originalRequest": { "header": [], "method": "GET", @@ -99243,40 +103825,34 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier for the user.", + "key": "useruuid", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "Method Not Allowed" }, { "_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 indicate how many seconds to wait before retrying.", "originalRequest": { "header": [], "method": "GET", @@ -99288,40 +103864,34 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier for the user.", + "key": "useruuid", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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 was understood but access is denied.", "originalRequest": { "header": [], "method": "GET", @@ -99333,42 +103903,46 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier for the user.", + "key": "useruuid", + "value": "" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 403, + "_postman_previewlanguage": "json", + "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"userName\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"name\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"middleName\": \"\",\n \"honorificPrefix\": \"\",\n \"honorificSuffix\": \"\"\n },\n \"organization\": \"\",\n \"displayName\": \"\"\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": [ @@ -99378,40 +103952,34 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier for the user.", + "key": "useruuid", + "value": "" } ] } }, - "status": "Forbidden" + "status": "OK" }, { "_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 must be force-downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -99423,40 +103991,34 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier for the user.", + "key": "useruuid", + "value": "" } ] } }, - "status": "Method Not Allowed" + "status": "Precondition Required" }, { "_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 time and the request has been rate limited. A Retry-After header indicates how many seconds to wait before retrying.", "originalRequest": { "header": [], "method": "GET", @@ -99468,40 +104030,34 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier for the user.", + "key": "useruuid", + "value": "" } ] } }, - "status": "Bad Gateway" + "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: The server is overloaded with requests. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -99513,40 +104069,34 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier for the user.", + "key": "useruuid", + "value": "" } ] } }, - "status": "Precondition Required" + "status": "Service Unavailable" }, { "_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": { "header": [], "method": "GET", @@ -99558,40 +104108,34 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier for the user.", + "key": "useruuid", + "value": "" } ] } }, - "status": "Gateway Timeout" + "status": "Internal Server Error" }, { "_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 an existing system rule. For example, a person may not be added to a room more than once.", "originalRequest": { "header": [], "method": "GET", @@ -99603,80 +104147,63 @@ "identity", "organizations", ":orgId", - "jobs", - "sendActivationEmails", - ":jobId", - "errors" - ], - "query": [ - { - "description": "Limit the maximum number of errors in the response.", - "key": "max", - "value": "50" - } + "v1", + "ArchivedUser", + ":useruuid" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors?max=50", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", "variable": [ { - "description": "Check job status for this organization.", - "key": "orgId" + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" }, { - "description": "Retrieve job status for this `jobId`.", - "key": "jobId" + "description": "The unique identifier for the user.", + "key": "useruuid", + "value": "" } ] } }, - "status": "Unsupported Media Type" + "status": "Conflict" } ] - } - ], - "name": "Send Activation Email" - }, - { - "description": "Operations for managing Service App access tokens", - "item": [ + }, { - "name": "Create Service App Access Token", + "name": "Query Archive User", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"targetOrgId\": \"\"\n}" - }, - "description": "Retrieves an organization specific token pair for an already authorized Service App. Service Apps use machine accounts to make API calls on behalf of an organization, independent of individual user life cycles.\n\nThis endpoint allows you to programmatically retrieve access and refresh tokens after a Full Admin has authorized your Service App in Control Hub.\n\nTo call this endpoint, you need an integration with the spark:applications_token scope.", + "description": "Retrieves archived user information for the specified organization. Supported attributes are `id`, which is the unique identifier of a user in the system, and `username`. It is assigned when the user is created and can be retrieved through **GET Users** API.
\n\n**Authorization**\n\nOAuth token issued by the Identity Broker.\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`.\n- `identity:people_read`.\n\nThe following administrators can use this API:\n\n- `Account in the specified organization with one of the following roles: id_full_admin, id_user_admin, id_readonly_admin`.\n- `Proxy account managing the specified organization with one of the following roles: id_full_admin, id_user_admin, id_readonly_admin`.\n\n
", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "applications", - ":applicationId", - "token" + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" ], - "raw": "{{baseUrl}}/applications/:applicationId/token", + "query": [ + { + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", "variable": [ { - "description": "The unique identifier of the Service App", - "key": "applicationId", + "description": "The unique identifier for the organization.", + "key": "orgId", "value": "" } ] @@ -99684,174 +104211,89 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"message\": \"\",\n \"trackingId\": \"\",\n \"errors\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": null, + "code": 400, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Forbidden - Insufficient permissions or Service App not authorized by Full Admin in Control Hub", + "header": [], + "name": "Bad Request: The request was invalid or cannot be processed. An accompanying error message explains the issue.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"targetOrgId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "applications", - ":applicationId", - "token" + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" ], - "raw": "{{baseUrl}}/applications/:applicationId/token", - "variable": [ + "query": [ { - "description": "The unique identifier of the Service App", - "key": "applicationId", + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", "value": "" } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"refresh_token\": \"\",\n \"refresh_token_expires_in\": \"\",\n \"token_type\": \"\"\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Successfully created Service App access token", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"targetOrgId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "applications", - ":applicationId", - "token" ], - "raw": "{{baseUrl}}/applications/:applicationId/token", + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", "variable": [ { - "description": "The unique identifier of the Service App", - "key": "applicationId", + "description": "The unique identifier for the organization.", + "key": "orgId", "value": "" } ] } }, - "status": "OK" + "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"message\": \"\",\n \"trackingId\": \"\",\n \"errors\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": null, + "code": 410, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Service App not found", + "header": [], + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"targetOrgId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "applications", - ":applicationId", - "token" + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" ], - "raw": "{{baseUrl}}/applications/:applicationId/token", + "query": [ + { + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", "variable": [ { - "description": "The unique identifier of the Service App", - "key": "applicationId", + "description": "The unique identifier for the organization.", + "key": "orgId", "value": "" } ] } }, - "status": "Not Found" + "status": "Gone" }, { "_postman_previewlanguage": "json", - "body": "{\n \"message\": \"\",\n \"trackingId\": \"\",\n \"errors\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n}", - "code": 401, + "body": "{\n \"totalResults\": \"\",\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Resources\": [\n {\n \"id\": \"\",\n \"userName\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"name\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"middleName\": \"\",\n \"honorificPrefix\": \"\",\n \"honorificSuffix\": \"\"\n },\n \"organization\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"userName\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"name\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"middleName\": \"\",\n \"honorificPrefix\": \"\",\n \"honorificSuffix\": \"\"\n },\n \"organization\": \"\",\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"displayName\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { @@ -99859,224 +104301,164 @@ "value": "application/json" } ], - "name": "Unauthorized - Authentication required", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"targetOrgId\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "applications", - ":applicationId", - "token" + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" ], - "raw": "{{baseUrl}}/applications/:applicationId/token", + "query": [ + { + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", "variable": [ { - "description": "The unique identifier of the Service App", - "key": "applicationId", + "description": "The unique identifier for the organization.", + "key": "orgId", "value": "" } ] } }, - "status": "Unauthorized" + "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"message\": \"\",\n \"trackingId\": \"\",\n \"errors\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": null, + "code": 409, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Bad request - Invalid input parameters", + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with an existing system rule. 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 \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"targetOrgId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "applications", - ":applicationId", - "token" + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" ], - "raw": "{{baseUrl}}/applications/:applicationId/token", - "variable": [ + "query": [ { - "description": "The unique identifier of the Service App", - "key": "applicationId", + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", "value": "" } - ] - } - }, - "status": "Bad Request" - } - ] - } - ], - "name": "Service Apps" - }, - { - "item": [ - { - "name": "Get Live Meeting metrics categorized by Country", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, - "description": "Retrieve live meeting metrics categorized by country for a specific meeting site or for all meeting sites owned by the customer. \n\nTo retrieve live monitoring information, you must use an administrator token with the `analytics:read_all` [scope](/docs/integrations#scopes). The authenticated user must be a read-only or full administrator of the organization to which the meeting belongs and must not be an external administrator.\n\nTo use this endpoint, the org needs to be licensed for the Webex Pro Pack.\n\nA rate limit of one API call per minute applies to each customer organization", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "livemonitoring", - "liveMeetingsByCountry" - ], - "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" - } - }, - "response": [ + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", + "variable": [ + { + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" + } + ] + } + }, + "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "livemonitoring", - "liveMeetingsByCountry" + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" ], - "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" + "query": [ + { + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", + "variable": [ + { + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" + } + ] } }, - "status": "Service Unavailable" + "status": "Gateway Timeout" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "livemonitoring", - "liveMeetingsByCountry" + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" ], - "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" + "query": [ + { + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", + "variable": [ + { + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" + } + ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -100084,34 +104466,36 @@ "code": 502, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Bad Gateway: The server received an invalid response from an upstream server. Try again later.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "livemonitoring", - "liveMeetingsByCountry" + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" ], - "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" + "query": [ + { + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", + "variable": [ + { + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" + } + ] } }, "status": "Bad Gateway" @@ -100119,336 +104503,375 @@ { "_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 invalid.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "livemonitoring", - "liveMeetingsByCountry" + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" ], - "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" + "query": [ + { + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", + "variable": [ + { + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" + } + ] } }, - "status": "Bad Request" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 423, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may indicate how many seconds to wait before retrying.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "livemonitoring", - "liveMeetingsByCountry" + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" ], - "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" + "query": [ + { + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", + "variable": [ + { + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" + } + ] } }, - "status": "Method Not Allowed" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 429, "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": "Too Many Requests: Too many requests have been sent in a given time and the request has been rate limited. A Retry-After header indicates how many seconds to wait before retrying.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "livemonitoring", - "liveMeetingsByCountry" + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" ], - "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" + "query": [ + { + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", + "variable": [ + { + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" + } + ] } }, - "status": "Gateway Timeout" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 503, "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": "Service Unavailable: The server is overloaded with requests. Try again later.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "livemonitoring", - "liveMeetingsByCountry" + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" ], - "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" + "query": [ + { + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", + "variable": [ + { + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" + } + ] } }, - "status": "Internal Server Error" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 405, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Method Not Allowed: The request was made using an unsupported HTTP method.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "livemonitoring", - "liveMeetingsByCountry" + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" ], - "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" + "query": [ + { + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", + "variable": [ + { + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" + } + ] } }, - "status": "Unauthorized" + "status": "Method Not Allowed" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"totalLiveMeetingCount\": \"\",\n \"totalLiveParticipantCount\": \"\",\n \"totalGoodQualityLiveMeetingCount\": \"\",\n \"totalGoodQualityLiveParticipantCount\": \"\",\n \"totalBadQualityMeetingCount\": \"\",\n \"totalBadQualityParticipantCount\": \"\",\n \"locations\": [\n {\n \"country\": \"\",\n \"countryLatitude\": \"\",\n \"countryLongitude\": \"\",\n \"liveMeetingCount\": \"\",\n \"liveParticipantCount\": \"\",\n \"badQualityLiveMeetingCount\": \"\",\n \"badQualityLiveParticipantCount\": \"\",\n \"goodQualityLiveMeetingCount\": \"\",\n \"goodQualityLiveParticipantCount\": \"\"\n },\n {\n \"country\": \"\",\n \"countryLatitude\": \"\",\n \"countryLongitude\": \"\",\n \"liveMeetingCount\": \"\",\n \"liveParticipantCount\": \"\",\n \"badQualityLiveMeetingCount\": \"\",\n \"badQualityLiveParticipantCount\": \"\",\n \"goodQualityLiveMeetingCount\": \"\",\n \"goodQualityLiveParticipantCount\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" - } - ], - "name": "OK", + "header": [], + "name": "Forbidden: The request was understood but access is denied.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "livemonitoring", - "liveMeetingsByCountry" + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" ], - "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" + "query": [ + { + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", + "variable": [ + { + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" + } + ] } }, - "status": "OK" + "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 requested URI is invalid, or the resource (such as a user) does not exist. Also returned when the requested format is not supported for the method.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" + ], + "query": [ + { + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", + "value": "" } - }, - "raw": "{\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", + "variable": [ + { + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and must be force-downloaded.", + "originalRequest": { + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "livemonitoring", - "liveMeetingsByCountry" + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" ], - "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" + "query": [ + { + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", + "variable": [ + { + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" + } + ] } }, - "status": "Too Many Requests" + "status": "Precondition Required" }, { "_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 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 \"siteIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "livemonitoring", - "liveMeetingsByCountry" + "identity", + "organizations", + ":orgId", + "v1", + "ArchivedUser" ], - "raw": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry" + "query": [ + { + "description": "A SCIM-style filter expression used to search archived users. Supported attributes are `username` and `id`, and only the `eq` operator is supported.\n\nExamples:\n\n- `username eq \"test_user_1@example.com\"`\n- `id eq \"40929cc6-2df2-4ab5-871c-ec8e38f07b93\"`", + "key": "filter", + "value": "" + } + ], + "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser?filter=", + "variable": [ + { + "description": "The unique identifier for the organization.", + "key": "orgId", + "value": "" + } + ] } }, - "status": "Not Found" + "status": "Unsupported Media Type" } ] } ], - "name": "Live Monitoring" + "name": "Archive Users" }, { + "description": "Webex Calling call and media-quality metrics.", "item": [ { - "name": "Get Archive User", + "name": "Webex Calling Call Quality Stats", "request": { - "description": "The `useruuid` is the unique identifier of a user in the system. It is assigned when the user is created and can be retrieved through **GET Users** API.
\n\n**Authorization**\n\nOAuth token issued by the Identity Broker.\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`.\n- `identity:people_read`.\n\nThe following administrators can use this API:\n\n- `Account in the specified organization with one of the following roles: id_full_admin, id_user_admin, id_readonly_admin`.\n- `Proxy account managing the specified organization with one of the following roles: id_full_admin, id_user_admin, id_readonly_admin`.\n\n
", + "description": "Returns aggregated Webex Calling call and media-quality statistics for the authenticated organization. A call or media session is classified as good quality when all available audio and video quality measurements meet their defined thresholds. Missing individual quality measurements do not cause the call or session to be classified as poor quality.\n\nYou can query data for a time range of up to seven days within the previous 3 weeks. For older historical data, use the Webex Calling Media Quality dashboard or reports. For more information on Media Quality KPI definitions, [click here](https://help.webex.com/en-us/article/n0rlwxe/Analytics-for-Your-Cloud-Collaboration-Portfolio#Cisco_Concept.dita_7609f9dc-3b80-4c0f-9456-5aaa385c4e27).\n\nThis operation requires a Pro Pack for Control Hub license. The access token must include the analytics:read_all scope and represent either a full administrator or read-only administrator. The organization is derived from the access token.\n\n
The base URL for these APIs is **analytics.webexapis.com**, which does not work with the **Try It** feature.
", "header": [ { "key": "Accept", @@ -100461,36 +104884,38 @@ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, "response": [ { "_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", @@ -100499,37 +104924,39 @@ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, - "status": "Gone" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 429, "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": "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", @@ -100538,37 +104965,39 @@ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, - "status": "Gateway Timeout" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 428, "cookie": [], "header": [], - "name": "Not Found: The requested URI is invalid, or the resource (such as a user) does not exist. Also returned when the requested format is not supported for the method.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -100577,37 +105006,39 @@ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, - "status": "Not Found" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 415, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server. 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": { "header": [], "method": "GET", @@ -100616,29 +105047,31 @@ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, - "status": "Bad Gateway" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", @@ -100646,7 +105079,7 @@ "code": 400, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be processed. An accompanying error message explains the issue.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], "method": "GET", @@ -100655,26 +105088,28 @@ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, "status": "Bad Request" @@ -100682,10 +105117,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 404, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or invalid.", + "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", @@ -100694,37 +105129,39 @@ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 504, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made 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": { "header": [], "method": "GET", @@ -100733,29 +105170,31 @@ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, - "status": "Unsupported Media Type" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -100763,7 +105202,7 @@ "code": 405, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made using an unsupported HTTP 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", @@ -100772,26 +105211,28 @@ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, "status": "Method Not Allowed" @@ -100799,10 +105240,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 502, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may indicate how many seconds to wait before retrying.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -100811,37 +105252,39 @@ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 500, "cookie": [], "header": [], - "name": "Forbidden: The request was understood but access is denied.", + "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", @@ -100850,86 +105293,80 @@ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"userName\": \"\",\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"work\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"meta\": {\n \"created\": \"\",\n \"lastModified\": \"\",\n \"version\": \"\",\n \"location\": \"\",\n \"resourceType\": \"\",\n \"organizationID\": \"\"\n },\n \"name\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"middleName\": \"\",\n \"honorificPrefix\": \"\",\n \"honorificSuffix\": \"\"\n },\n \"organization\": \"\",\n \"displayName\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 410, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, - "status": "OK" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 423, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and must 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", @@ -100938,76 +105375,90 @@ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, - "status": "Precondition Required" + "status": "Locked (WebDAV) (RFC 4918)" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 429, + "_postman_previewlanguage": "json", + "body": "{\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"metrics\": {\n \"totalCalls\": \"\",\n \"totalCallsWithMedia\": \"\",\n \"totalGoodQualityCallsWithMedia\": \"\",\n \"totalMediaSessions\": \"\",\n \"totalGoodMediaSessions\": \"\",\n \"avgCallLegAudioJitter\": \"\",\n \"avgCallLegAudioLatency\": \"\",\n \"avgCallLegAudioPacketLoss\": \"\"\n },\n \"location\": \"\"\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given time and the request has been rate limited. A Retry-After header indicates how many seconds to wait before retrying.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 401, "cookie": [], "header": [], - "name": "Service Unavailable: The server is overloaded with requests. Try again later.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], "method": "GET", @@ -101016,37 +105467,39 @@ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, - "status": "Service Unavailable" + "status": "Unauthorized" }, { "_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": { "header": [], "method": "GET", @@ -101055,37 +105508,39 @@ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 503, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with an existing system rule. 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": { "header": [], "method": "GET", @@ -101094,34 +105549,36 @@ "{{baseUrl}}" ], "path": [ - "identity", - "organizations", - ":orgId", "v1", - "ArchivedUser", - ":useruuid" + "analytics", + "callQualityStats" ], - "raw": "{{baseUrl}}/identity/organizations/:orgId/v1/ArchivedUser/:useruuid", - "variable": [ + "query": [ { - "description": "The unique identifier for the organization.", - "key": "orgId", - "value": "" + "description": "Inclusive UTC start time in yyyy-MM-ddTHH:mm:ssZ format. If omitted while to is provided, it is seven days before the effective to time. If both times are omitted, it is seven days before the current time.", + "key": "from", + "value": "3528-25-71T09:37:97Z" }, { - "description": "The unique identifier for the user.", - "key": "useruuid", + "description": "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.", + "key": "to", + "value": "3528-25-71T09:37:97Z" + }, + { + "description": "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.", + "key": "location", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/analytics/callQualityStats?from=3528-25-71T09:37:97Z&to=3528-25-71T09:37:97Z&location=" } }, - "status": "Conflict" + "status": "Service Unavailable" } ] } ], - "name": "Archive Users" + "name": "Calling Metrics" } ], "variable": [ diff --git a/codegen/postman/Webex Cloud Calling.postman_collection.json b/codegen/postman/Webex Cloud Calling.postman_collection.json index 07a5977..0447423 100644 --- a/codegen/postman/Webex Cloud Calling.postman_collection.json +++ b/codegen/postman/Webex Cloud Calling.postman_collection.json @@ -40666,6 +40666,3383 @@ "status": "Internal Server Error" } ] + }, + { + "name": "Dial", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "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": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "response": [ + { + "_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 \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "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 \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "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 \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"callId\": \"\",\n \"callSessionId\": \"\"\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 \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "status": "Created" + }, + { + "_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 \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_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 \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "status": "Precondition Required" + }, + { + "_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 \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "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 \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "status": "Unauthorized" + }, + { + "_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 \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "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 \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "status": "Method Not Allowed" + }, + { + "_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 \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "status": "Gone" + }, + { + "_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 \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "dial" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/dial" + } + }, + "status": "Conflict" + } + ] + }, + { + "name": "Answer", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "description": "Answer an incoming call. When no endpointId is specified, the call is answered on the user's primary device. When an endpointId is specified, the call is answered on the device or application identified by the endpointId. The answer API is rejected if the device is not alerting for the call or the device does not support answer via API.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "response": [ + { + "_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 \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "status": "Unauthorized" + }, + { + "_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 \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "status": "Precondition Required" + }, + { + "_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 \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "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 \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "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 \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "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 \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "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 \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "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 \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "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 \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "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 \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "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 \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "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 \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "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 \"callId\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "answer" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/answer" + } + }, + "status": "Bad Request" + } + ] + }, + { + "name": "Hangup", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "description": "Hangup a call. If used on an unanswered incoming call, the call is rejected and sent to busy.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "response": [ + { + "_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 \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "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 \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "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 \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "status": "Bad Request" + }, + { + "_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 \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "status": "Gone" + }, + { + "_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 \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "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).", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "status": "Internal Server Error" + }, + { + "_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 \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "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 \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "status": "No Content" + }, + { + "_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 \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "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": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "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 \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "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 \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "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 \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "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 \"callId\": \"\",\n \"lineOwnerId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "hangup" + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/hangup" + } + }, + "status": "Bad Gateway" + } + ] + }, + { + "name": "List Calls", + "request": { + "description": "Get the list of details for all active calls associated with the user.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "response": [ + { + "_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", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "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", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "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", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "status": "Method Not Allowed" + }, + { + "_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", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "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", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "status": "Unauthorized" + }, + { + "_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", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"callSessionId\": \"\",\n \"personality\": \"originator\",\n \"state\": \"alerting\",\n \"remoteParty\": {\n \"privacyEnabled\": \"\",\n \"callType\": \"organization\",\n \"name\": \"\",\n \"number\": \"\",\n \"personId\": \"\",\n \"placeId\": \"\"\n },\n \"created\": \"\",\n \"muteCapable\": \"\",\n \"muted\": \"\",\n \"appearance\": \"\",\n \"answered\": \"\",\n \"redirections\": [\n {\n \"reason\": \"callQueue\",\n \"redirectingParty\": {\n \"privacyEnabled\": \"\",\n \"callType\": \"external\",\n \"name\": \"\",\n \"number\": \"\",\n \"personId\": \"\",\n \"placeId\": \"\"\n }\n },\n {\n \"reason\": \"followMe\",\n \"redirectingParty\": {\n \"privacyEnabled\": \"\",\n \"callType\": \"other\",\n \"name\": \"\",\n \"number\": \"\",\n \"personId\": \"\",\n \"placeId\": \"\"\n }\n }\n ],\n \"recall\": {\n \"type\": \"park\",\n \"party\": {\n \"privacyEnabled\": \"\",\n \"callType\": \"other\",\n \"name\": \"\",\n \"number\": \"\",\n \"personId\": \"\",\n \"placeId\": \"\"\n }\n },\n \"recordingState\": \"pending\"\n },\n {\n \"id\": \"\",\n \"callSessionId\": \"\",\n \"personality\": \"clickToDial\",\n \"state\": \"remoteHeld\",\n \"remoteParty\": {\n \"privacyEnabled\": \"\",\n \"callType\": \"other\",\n \"name\": \"\",\n \"number\": \"\",\n \"personId\": \"\",\n \"placeId\": \"\"\n },\n \"created\": \"\",\n \"muteCapable\": \"\",\n \"muted\": \"\",\n \"appearance\": \"\",\n \"answered\": \"\",\n \"redirections\": [\n {\n \"reason\": \"timeOfDay\",\n \"redirectingParty\": {\n \"privacyEnabled\": \"\",\n \"callType\": \"repair\",\n \"name\": \"\",\n \"number\": \"\",\n \"personId\": \"\",\n \"placeId\": \"\"\n }\n },\n {\n \"reason\": \"unavailable\",\n \"redirectingParty\": {\n \"privacyEnabled\": \"\",\n \"callType\": \"organization\",\n \"name\": \"\",\n \"number\": \"\",\n \"personId\": \"\",\n \"placeId\": \"\"\n }\n }\n ],\n \"recall\": {\n \"type\": \"park\",\n \"party\": {\n \"privacyEnabled\": \"\",\n \"callType\": \"emergency\",\n \"name\": \"\",\n \"number\": \"\",\n \"personId\": \"\",\n \"placeId\": \"\"\n }\n },\n \"recordingState\": \"stopped\"\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", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "status": "OK" + }, + { + "_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", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "status": "Unsupported Media Type" + }, + { + "_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", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_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", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "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", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "status": "Gateway Timeout" + }, + { + "_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", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "status": "Gone" + }, + { + "_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", + "calls", + "members", + "me", + "calls" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls?lineOwnerId=" + } + }, + "status": "Bad Gateway" + } + ] + }, + { + "name": "Get Call Details", + "request": { + "description": "Get the details of the specified active call for the user.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_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", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "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", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"callSessionId\": \"\",\n \"personality\": \"terminator\",\n \"state\": \"connecting\",\n \"remoteParty\": {\n \"privacyEnabled\": \"\",\n \"callType\": \"location\",\n \"name\": \"\",\n \"number\": \"\",\n \"personId\": \"\",\n \"placeId\": \"\"\n },\n \"created\": \"\",\n \"muteCapable\": \"\",\n \"muted\": \"\",\n \"appearance\": \"\",\n \"answered\": \"\",\n \"redirections\": [\n {\n \"reason\": \"followMe\",\n \"redirectingParty\": {\n \"privacyEnabled\": \"\",\n \"callType\": \"external\",\n \"name\": \"\",\n \"number\": \"\",\n \"personId\": \"\",\n \"placeId\": \"\"\n }\n },\n {\n \"reason\": \"unavailable\",\n \"redirectingParty\": {\n \"privacyEnabled\": \"\",\n \"callType\": \"external\",\n \"name\": \"\",\n \"number\": \"\",\n \"personId\": \"\",\n \"placeId\": \"\"\n }\n }\n ],\n \"recall\": {\n \"type\": \"park\",\n \"party\": {\n \"privacyEnabled\": \"\",\n \"callType\": \"other\",\n \"name\": \"\",\n \"number\": \"\",\n \"personId\": \"\",\n \"placeId\": \"\"\n }\n },\n \"recordingState\": \"pending\"\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", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "value": "" + } + ] + } + }, + "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", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "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", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "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", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_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", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "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", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "value": "" + } + ] + } + }, + "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", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "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", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_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", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_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", + "calls", + "members", + "me", + "calls", + ":callId" + ], + "query": [ + { + "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.", + "key": "lineOwnerId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/calls/members/me/calls/:callId?lineOwnerId=", + "variable": [ + { + "description": "The call identifier of the call.", + "key": "callId", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + } + ] } ], "name": "Call Controls" @@ -84386,7 +87763,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\": \"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]", + "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\": \"UNKNOWN\"\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": [ diff --git a/codegen/postman/Webex Contact Center.postman_collection.json b/codegen/postman/Webex Contact Center.postman_collection.json index 6c8dcc1..ab41777 100644 --- a/codegen/postman/Webex Contact Center.postman_collection.json +++ b/codegen/postman/Webex Contact Center.postman_collection.json @@ -4508,7 +4508,7 @@ "response": [ { "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"19AbfcCFcCAFbaEc7ED8901bbAa4A8ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"39FA11E8E1BDf13C-dd538eF4d1dc9964\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": 9645.32385261695\n },\n \"data\": [\n {\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"19AbfcCFcCAFbaEc7ED8901bbAa4A8ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"39FA11E8E1BDf13C-dd538eF4d1dc9964\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -5018,7 +5018,7 @@ }, { "_postman_previewlanguage": "text", - "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}", + "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}", "code": 200, "cookie": [], "header": [ @@ -6642,9 +6642,9 @@ { "item": [ { - "name": "List Business Hours resource(s)", + "name": "List Business Hours resources", "request": { - "description": "Retrieve a list of Business Hours resource(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 Business Hours resources 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", @@ -6683,7 +6683,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -6750,7 +6750,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -6768,7 +6768,7 @@ }, { "_postman_previewlanguage": "text", - "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]", + "body": "[\n {\n \"organizationId\": \"983e2b8522eB-1C1B-29eE-aE99b3b74fCb\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"G\u2000sTli60l\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"9585f9Fb-C856-A0Cb1Fa1-1FC9AADAdC3D\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"8ZHV\u205f8\\r41B\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -6817,7 +6817,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -6884,7 +6884,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -6951,7 +6951,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -7018,7 +7018,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -7085,7 +7085,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -7529,7 +7529,7 @@ ] }, { - "name": "Bulk save Business Hours resource(s)", + "name": "Bulk save Business Hours resources", "request": { "body": { "mode": "raw", @@ -7541,7 +7541,7 @@ }, "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"uEItTYKFIn\u202fz9\u180e5KEEmR69_6vPou\u1680OP\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"SUN\"\n ],\n \"name\": \"_khN\u3000Q9bh\u2004EmW3AwGmUS8_Nl\\rccf6CDSvKYSr9\\nw\u1680omu-jA\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"MON\",\n \"WED\"\n ],\n \"name\": \"-ov1gcQAULg6jWbjd\u20081yfrox\\f27ppdcXXE1Vdq3\u2001HPTPrTQ\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"4C41B5e4bb3fEa9f-9bF72dCcADCD8728\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"-4Li4_bBM2c\u00a0AhyPmRpgXk5d_l\u2028dD6xXL19t\\fW1HdgjQ\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"SAT\",\n \"SUN\"\n ],\n \"name\": \"m7wTQQz\u200an8EVRgsJALCYh8JBPxB\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"THU\",\n \"SAT\"\n ],\n \"name\": \"81K7WTAxOr3tUKAfPd-\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"80FD6ebF05e9-9Ff7eEc4-9C6520C35163\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Create, Update or delete Business Hours resource(s) in bulk in a given organization.", + "description": "Create, Update or delete Business Hours resources in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -8354,7 +8354,7 @@ "value": "" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id", "value": "" } @@ -8399,7 +8399,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -8444,7 +8444,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -8489,7 +8489,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -8534,7 +8534,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -8579,7 +8579,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -8624,7 +8624,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -8677,7 +8677,7 @@ "value": "" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id", "value": "" } @@ -8736,7 +8736,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -8795,7 +8795,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -8854,7 +8854,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -8913,7 +8913,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -8972,7 +8972,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -9031,7 +9031,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -9090,7 +9090,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -9149,7 +9149,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -9188,7 +9188,7 @@ "value": "" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id", "value": "" } @@ -9233,7 +9233,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -9278,7 +9278,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -9323,7 +9323,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -9368,7 +9368,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -9403,7 +9403,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -9448,7 +9448,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -9493,7 +9493,7 @@ "key": "orgid" }, { - "description": "Resource ID of the Business Hours resource.", + "description": "Resource ID of the Business Hour.", "key": "id" } ] @@ -9939,9 +9939,9 @@ ] }, { - "name": "List Business Hours resource(s)", + "name": "List Business Hours resources", "request": { - "description": "Retrieve a list of Business Hours resource(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 Business Hours resources 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", @@ -9991,12 +9991,12 @@ "value": "timeZone" }, { - "description": "Enable the flag to get the count of workingHours", + "description": "Enable this flag to get the count of working hours.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -10014,7 +10014,7 @@ "response": [ { "_postman_previewlanguage": "text", - "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}", + "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}", "code": 200, "cookie": [], "header": [ @@ -10074,12 +10074,12 @@ "value": "timeZone" }, { - "description": "Enable the flag to get the count of workingHours", + "description": "Enable this flag to get the count of working hours.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -10157,12 +10157,12 @@ "value": "timeZone" }, { - "description": "Enable the flag to get the count of workingHours", + "description": "Enable this flag to get the count of working hours.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -10240,12 +10240,12 @@ "value": "timeZone" }, { - "description": "Enable the flag to get the count of workingHours", + "description": "Enable this flag to get the count of working hours.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -10323,12 +10323,12 @@ "value": "timeZone" }, { - "description": "Enable the flag to get the count of workingHours", + "description": "Enable this flag to get the count of working hours.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -10406,12 +10406,12 @@ "value": "timeZone" }, { - "description": "Enable the flag to get the count of workingHours", + "description": "Enable this flag to get the count of working hours.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -10489,12 +10489,12 @@ "value": "timeZone" }, { - "description": "Enable the flag to get the count of workingHours", + "description": "Enable this flag to get the count of working hours.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -10518,9 +10518,9 @@ { "item": [ { - "name": "List Holiday List(s)", + "name": "List Holiday Lists", "request": { - "description": "Retrieve a list of Holiday List(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 Holiday Lists 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", @@ -10559,7 +10559,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -10626,7 +10626,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -10693,7 +10693,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -10711,7 +10711,7 @@ }, { "_postman_previewlanguage": "text", - "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]", + "body": "[\n {\n \"organizationId\": \"d4c884DFFEdC-7b4f28bB1feb2ce2A0E2\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"9mGNE0HWbLft7\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"33d5F6B0fEfEa313-85fd-E2C6B5268029\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"8hH\u2004MxMRv9nzZ_\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -10760,7 +10760,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -10827,7 +10827,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -10894,7 +10894,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -10961,7 +10961,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -11405,7 +11405,7 @@ ] }, { - "name": "Bulk save Holiday List(s)", + "name": "Bulk save Holiday Lists", "request": { "body": { "mode": "raw", @@ -11417,7 +11417,7 @@ }, "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"holidays\": [\n {\n \"name\": \"cms4mlt8g\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"sPxB3cns3\u20059Yf\u20096Vl-4jb2IwV59POdXJRlA7MibKsWy_ 1KbHZI\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"7ym05l_\u200acCaoK\u1680HAg5mmgmdrc\\u000b-kSQ1BylxVlQrjzr\\f45TqIQPiDv\",\n \"organizationId\": \"E39AAdDA48aA-ffbabd42e5093E2d204f\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"holidays\": [\n {\n \"name\": \"dXnr\ufeffD1WrYxL_G60l\u2003R\ufeffA6X_\\tIgdZQsox4rKXn5gnE0pPcUE02E\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"Z1QBOSVHqO\\rZnZ96HI\ufeffNfox2frak1m\u202ftliNywEIztZHoY6QpUyhyt\u2009yYVn3wO6ic_\u205fAeEctu5A\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"QHg7dJbrW\\tcZEGpe_Xif8YeCbO9KRogUA-\u200atOxy\",\n \"organizationId\": \"F5f5bA188F110Ad3-0b8ed4FCbAFA9c28\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Create, Update or delete Holiday List(s) in bulk in a given organization.", + "description": "Create, Update or delete Holiday Lists in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -13815,9 +13815,9 @@ ] }, { - "name": "List Holiday List(s)", + "name": "List Holiday Lists", "request": { - "description": "Retrieve a list of Holiday List(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 Holiday Lists 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", @@ -13867,12 +13867,12 @@ "value": "name" }, { - "description": "Enable the flag to get the count of holidays", + "description": "Enable this flag to get the count of holidays.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -13950,12 +13950,12 @@ "value": "name" }, { - "description": "Enable the flag to get the count of holidays", + "description": "Enable this flag to get the count of holidays.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -14033,12 +14033,12 @@ "value": "name" }, { - "description": "Enable the flag to get the count of holidays", + "description": "Enable this flag to get the count of holidays.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -14116,12 +14116,12 @@ "value": "name" }, { - "description": "Enable the flag to get the count of holidays", + "description": "Enable this flag to get the count of holidays.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -14199,12 +14199,12 @@ "value": "name" }, { - "description": "Enable the flag to get the count of holidays", + "description": "Enable this flag to get the count of holidays.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -14222,7 +14222,7 @@ }, { "_postman_previewlanguage": "text", - "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}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": \"\"\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": [ @@ -14282,12 +14282,12 @@ "value": "name" }, { - "description": "Enable the flag to get the count of holidays", + "description": "Enable this flag to get the count of holidays.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -14365,12 +14365,12 @@ "value": "name" }, { - "description": "Enable the flag to get the count of holidays", + "description": "Enable this flag to get the count of holidays.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -14396,7 +14396,7 @@ { "name": "List Overrides resource(s)", "request": { - "description": "Retrieve a list of Overrides resource(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 Overrides resource(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", @@ -14520,7 +14520,7 @@ }, { "_postman_previewlanguage": "text", - "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]", + "body": "[\n {\n \"organizationId\": \"2d7d21a4d70051ddB53BbEAeEd222ae1\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"VUWM_Az\u2001fT_j8R9Yc\u3000AVI8KZP-6ZW\u2005a\\tGj\u2009QD\u1680qy256\u205f4xS0lmJP4j9QrX6e\\t0rEwdw8ceFc\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"latestOverride\": {\n \"name\": \"qFWf2PUQdG2\u2029Lu7IhYjKDSq3\u180eDAO\u205fZIy\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"Weekly\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"LAST\",\n \"daysOfWeek\": [\n \"SAT\",\n \"MON\",\n \"SUN\",\n \"SAT\",\n \"THU\",\n \"SUN\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUN\",\n \"endDate\": \"3124-58-29\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"D1402d7DdF0A5895be0c-fbCfbA3d4f0f\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"yHqcy576yQ jH\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"latestOverride\": {\n \"name\": \"VrRZ-8Z\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"Daily\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"SECOND\",\n \"daysOfWeek\": [\n \"THU\",\n \"TUE\",\n \"TUE\",\n \"THU\",\n \"TUE\",\n \"WED\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"MAR\",\n \"endDate\": \"6283-83-55\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -17693,7 +17693,7 @@ { "name": "List Overrides resource(s)", "request": { - "description": "Retrieve a list of Overrides resource(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 Overrides resource(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", @@ -18324,7 +18324,7 @@ "response": [ { "_postman_previewlanguage": "json", - "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]", + "body": "[\n {\n \"name\": \"Xp\u00a0t\u200a\u2008D\u2004\ufeff\",\n \"parentType\": \"SITE\",\n \"organizationId\": \"B3FfF4db-8d8a984c-ADab-b286cC4FBEc7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\u2004\",\n \"siteId\": \"\",\n \"addressBookEntries\": [\n {\n \"name\": \"\u2001Qe\u2002Xl\u200af-4\",\n \"number\": \"49(3(1-\",\n \"organizationId\": \"212F3B793cc0-32cd6E5e828cb8adCC0b\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\\rhf\u1680g\u2007f\",\n \"number\": \"+001-((8906\",\n \"organizationId\": \"dB3408DC4B0c-F94f-7bD3-2b9C055BDD1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"MxFz\",\n \"parentType\": \"ORGANIZATION\",\n \"organizationId\": \"688ad02Aa232f0A4B85C-Bcf2EAA6Ab5C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\u2005\ufeff\",\n \"siteId\": \"\",\n \"addressBookEntries\": [\n {\n \"name\": \"kLXf0\u180e\\n\u2008g\",\n \"number\": \"4(87\",\n \"organizationId\": \"59ABAc32-6Ae991f0-2b0e-556Ee6c3eD26\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"n5wwL\u1680\",\n \"number\": \"35\",\n \"organizationId\": \"0E3C925E-7467-A900-9FEAb53aD2EC31f1\",\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 \"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}", + "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}", "code": 200, "cookie": [], "header": [ @@ -29287,7 +29287,7 @@ }, { "_postman_previewlanguage": "json", - "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}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {},\n \"key_3\": {}\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\": \"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]", + "body": "[\n {\n \"active\": \"\",\n \"defaultCode\": \"\",\n \"name\": \"\\n\u205fs\u2006\u2004.Fvat\",\n \"workTypeCode\": \"IDLE_CODE\",\n \"workTypeId\": \"\",\n \"organizationId\": \"3b75FFe5-3dd4-2026e33B-82b57250874e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"isSystemCode\": \"\",\n \"burnoutInclusion\": \"NOT_APPLICABLE\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"defaultCode\": \"\",\n \"name\": \"c\\rj3T110\",\n \"workTypeCode\": \"WRAP_UP_CODE\",\n \"workTypeId\": \"\",\n \"organizationId\": \"AEAef4fE364E3b4F-96fD480CB85da921\",\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 },\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 \"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": [ @@ -37267,9 +37267,9 @@ { "item": [ { - "name": "List Contact Service Queue(s)", + "name": "List Contact Service Queues", "request": { - "description": "Retrieve a list of Contact Service Queue(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 Contact Service Queues 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. Deprecated. Use GET /v2/contact-service-queue instead.", "header": [ { "key": "Accept", @@ -37313,7 +37313,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -37385,7 +37385,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -37457,7 +37457,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -37529,7 +37529,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -37601,7 +37601,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -37673,7 +37673,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -37691,7 +37691,7 @@ }, { "_postman_previewlanguage": "text", - "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]", + "body": "[\n {\n \"organizationId\": \"8ae5FE01aCD2c448b7bC-AeDD4d2606CB\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"queueType\": \"OUTBOUND\",\n \"checkAgentAvailability\": \"\",\n \"channelType\": \"CUSTOM_MESSAGING\",\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\": \"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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"CDeA4322-9cdC-Cdb8-8dde6e70feDabfD9\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"queueType\": \"INBOUND\",\n \"checkAgentAvailability\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"socialChannelType\": \"MESSAGEBIRD\",\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\": \"LINEAR\",\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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -37745,7 +37745,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -38189,7 +38189,7 @@ ] }, { - "name": "Bulk save Contact Service Queue(s)", + "name": "Bulk save Contact Service Queues", "request": { "body": { "mode": "raw", @@ -38201,7 +38201,7 @@ }, "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\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\": \"R8\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"AGENT_BASED\",\n \"queueType\": \"INBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"CIRCULAR\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"Ee1Bbf2379BC93db-F282-bAc3d9ef454c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"908\",\n \"vendorId\": \"\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"ba0ae5ddBeEc241abbB3-caeB5F7DE9D8\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"A9EebE27D3Da7c9eDE9E-D64B6eaf8886\",\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 },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\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\": \"9\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"E9c40F5C1Db568DEBbcD20FeF266bBE3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"816\",\n \"vendorId\": \"\u00a0\\nTcuQ\u1680\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"eDdCB71EF6a78A6d-B09226Ed3e24BdA4\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"eACCB76833cc4B78-aD27-6fFbB76e1FcC\",\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 },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Create, Update or delete Contact Service Queue(s) in bulk in a given organization.", + "description": "Create, Update or delete Contact Service Queues in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -38622,7 +38622,7 @@ ] }, { - "name": "Bulk partial update Contact Service Queue(s)", + "name": "Bulk partial update Contact Service Queues", "request": { "body": { "mode": "raw", @@ -38634,7 +38634,7 @@ }, "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\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\": \"R8\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"AGENT_BASED\",\n \"queueType\": \"INBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"CIRCULAR\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"Ee1Bbf2379BC93db-F282-bAc3d9ef454c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"908\",\n \"vendorId\": \"\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"ba0ae5ddBeEc241abbB3-caeB5F7DE9D8\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"A9EebE27D3Da7c9eDE9E-D64B6eaf8886\",\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 },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\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\": \"9\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"E9c40F5C1Db568DEBbcD20FeF266bBE3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"816\",\n \"vendorId\": \"\u00a0\\nTcuQ\u1680\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"eDdCB71EF6a78A6d-B09226Ed3e24BdA4\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"eACCB76833cc4B78-aD27-6fFbB76e1FcC\",\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 },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Update some or all properties for multiple Contact Service Queue(s) in bulk in a given organization.", + "description": "Update some or all properties for multiple Contact Service Queues in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -39454,9 +39454,9 @@ ] }, { - "name": "List Skill CSQs by Skill Profile", + "name": "List skill-based Contact Service Queues by skill profile ID (public)", "request": { - "description": "Retrieve skill-based Contact Service Queues by skill profile ID in a given organization.", + "description": "Retrieve a list of skill-based Contact Service Queues associated with a given skill profile ID, accessible to authorized clients in a given organization.", "header": [ { "key": "Accept", @@ -39539,7 +39539,7 @@ }, { "_postman_previewlanguage": "text", - "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}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": \"\"\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": [ @@ -39770,7 +39770,7 @@ ] }, { - "name": "Delete CSQ References", + "name": "Delete references from Contact Service Queues", "request": { "body": { "mode": "raw", @@ -39780,9 +39780,9 @@ "language": "json" } }, - "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" + "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}" }, - "description": "Delete references for Contact Service Queues in a given organization.", + "description": "Removes the references to the specified entities (such as teams, sites, or agents) from Contact Service Queues for a given organization.", "header": [ { "key": "Content-Type", @@ -39807,7 +39807,6 @@ "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": "" } @@ -39836,7 +39835,7 @@ "language": "json" } }, - "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" + "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}" }, "header": [ { @@ -39862,7 +39861,6 @@ "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" } ] @@ -39891,7 +39889,7 @@ "language": "json" } }, - "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" + "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}" }, "header": [ { @@ -39917,7 +39915,6 @@ "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" } ] @@ -39946,7 +39943,7 @@ "language": "json" } }, - "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" + "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}" }, "header": [ { @@ -39972,7 +39969,6 @@ "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" } ] @@ -40001,7 +39997,7 @@ "language": "json" } }, - "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" + "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}" }, "header": [ { @@ -40027,7 +40023,6 @@ "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 +40032,7 @@ }, { "_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}", + "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": [ @@ -40056,7 +40051,7 @@ "language": "json" } }, - "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" + "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}" }, "header": [ { @@ -40082,7 +40077,6 @@ "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" } ] @@ -40111,7 +40105,7 @@ "language": "json" } }, - "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" + "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}" }, "header": [ { @@ -40137,7 +40131,6 @@ "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" } ] @@ -40166,7 +40159,7 @@ "language": "json" } }, - "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" + "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}" }, "header": [ { @@ -40192,7 +40185,6 @@ "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" } ] @@ -40203,7 +40195,7 @@ ] }, { - "name": "List Manually Assignable CSQs", + "name": "List manually assignable Contact Service Queues", "request": { "body": { "mode": "raw", @@ -40215,7 +40207,7 @@ }, "raw": "{\n \"agentId\": \"\",\n \"teamId\": \"\"\n}" }, - "description": "Retrieve manually assignable Contact Service Queues in a given organization.", + "description": "Retrieve a list of Contact Service Queues that are eligible for manual contact assignment based on the provided criteria in a given organization.", "header": [ { "key": "Content-Type", @@ -40360,7 +40352,7 @@ }, { "_postman_previewlanguage": "text", - "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}", + "body": "{\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": [ @@ -40369,7 +40361,7 @@ "value": "*/*" } ], - "name": "OK", + "name": "Successfully fetched the manually assignable contact service queues for the given agent and team.", "originalRequest": { "body": { "mode": "raw", @@ -40636,9 +40628,9 @@ ] }, { - "name": "Purge inactive Contact Service Queue(s)", + "name": "Purge inactive Contact Service Queues", "request": { - "description": "Purge inactive Contact Service Queue(s) older than the configured interval for a given organization.", + "description": "Purge inactive Contact Service Queues older than the configured interval for a given organization.", "header": [ { "key": "Accept", @@ -40658,7 +40650,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -40706,7 +40698,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -40754,7 +40746,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -40802,7 +40794,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -40850,7 +40842,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -40898,7 +40890,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -40916,7 +40908,7 @@ }, { "_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}", + "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": [ @@ -40946,7 +40938,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -40994,7 +40986,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -41266,7 +41258,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 \"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}", + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -42240,7 +42232,7 @@ ] }, { - "name": "List CSQ References by ID", + "name": "List references for a specific Contact Service Queue", "request": { "description": "Retrieve a list of all entities that have reference to an existing Contact Service Queue by ID in a given organization.", "header": [ @@ -42675,7 +42667,7 @@ ] }, { - "name": "Bulk save Contact Service Queue(s)", + "name": "Bulk save Contact Service Queues", "request": { "body": { "mode": "raw", @@ -42687,7 +42679,7 @@ }, "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\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\": \"R8\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"AGENT_BASED\",\n \"queueType\": \"INBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"CIRCULAR\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"Ee1Bbf2379BC93db-F282-bAc3d9ef454c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"908\",\n \"vendorId\": \"\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"ba0ae5ddBeEc241abbB3-caeB5F7DE9D8\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"A9EebE27D3Da7c9eDE9E-D64B6eaf8886\",\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 },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\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\": \"9\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"E9c40F5C1Db568DEBbcD20FeF266bBE3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"816\",\n \"vendorId\": \"\u00a0\\nTcuQ\u1680\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"eDdCB71EF6a78A6d-B09226Ed3e24BdA4\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"eACCB76833cc4B78-aD27-6fFbB76e1FcC\",\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 },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Create, Update or delete Contact Service Queue(s) in bulk in a given organization.", + "description": "Create, Update or delete Contact Service Queues in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -43116,9 +43108,9 @@ ] }, { - "name": "List Contact Service Queue(s)", + "name": "List Contact Service Queues", "request": { - "description": "Retrieve a list of Contact Service Queue(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 Contact Service Queues 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", @@ -43168,17 +43160,17 @@ "value": "false" }, { - "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.", + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects 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.", + "description": "If set to true, the API response will include the count of each AI feature mapped to the entity.", "key": "includeAIMappingCount", "value": "false" } @@ -43256,17 +43248,17 @@ "value": "false" }, { - "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.", + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects 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.", + "description": "If set to true, the API response will include the count of each AI feature mapped to the entity.", "key": "includeAIMappingCount", "value": "false" } @@ -43344,17 +43336,17 @@ "value": "false" }, { - "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.", + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects 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.", + "description": "If set to true, the API response will include the count of each AI feature mapped to the entity.", "key": "includeAIMappingCount", "value": "false" } @@ -43432,17 +43424,17 @@ "value": "false" }, { - "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.", + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects 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.", + "description": "If set to true, the API response will include the count of each AI feature mapped to the entity.", "key": "includeAIMappingCount", "value": "false" } @@ -43520,17 +43512,17 @@ "value": "false" }, { - "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.", + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects 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.", + "description": "If set to true, the API response will include the count of each AI feature mapped to the entity.", "key": "includeAIMappingCount", "value": "false" } @@ -43608,17 +43600,17 @@ "value": "false" }, { - "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.", + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects 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.", + "description": "If set to true, the API response will include the count of each AI feature mapped to the entity.", "key": "includeAIMappingCount", "value": "false" } @@ -43696,17 +43688,17 @@ "value": "false" }, { - "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.", + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects 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.", + "description": "If set to true, the API response will include the count of each AI feature mapped to the entity.", "key": "includeAIMappingCount", "value": "false" } @@ -43735,7 +43727,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "description": "Create a new Contact Service Queue in a given organization.", "header": [ @@ -43791,7 +43783,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -43846,7 +43838,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -43901,7 +43893,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -43956,7 +43948,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -44011,7 +44003,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -44047,7 +44039,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 \"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}", + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 201, "cookie": [], "header": [ @@ -44066,7 +44058,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -44121,7 +44113,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -44158,9 +44150,9 @@ ] }, { - "name": "List agent based Contact Service Queue(s)by user ID", + "name": "List agent-based Contact Service Queues 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 Queues by user ID in a given organization.", "header": [ { "key": "Accept", @@ -44471,7 +44463,7 @@ }, { "_postman_previewlanguage": "text", - "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}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": \"\"\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": [ @@ -44600,9 +44592,9 @@ ] }, { - "name": "List skill based Contact Service Queue(s)by user ID", + "name": "List skill-based Contact Service Queues 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 Queues by user ID in a given organization.", "header": [ { "key": "Accept", @@ -44721,7 +44713,7 @@ }, { "_postman_previewlanguage": "text", - "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}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": \"\"\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": [ @@ -45042,9 +45034,9 @@ ] }, { - "name": "List team based Contact Service Queue(s)by user ID", + "name": "List team-based Contact Service Queues 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 Queues by user ID in a given organization.", "header": [ { "key": "Accept", @@ -45355,7 +45347,7 @@ }, { "_postman_previewlanguage": "text", - "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}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": \"\"\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": [ @@ -45742,7 +45734,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 \"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}", + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -45859,7 +45851,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "description": "Update an existing Contact Service Queue by ID in a given organization.", "header": [ @@ -45921,7 +45913,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -45981,7 +45973,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -46022,7 +46014,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 \"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}", + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -46041,7 +46033,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -46101,7 +46093,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -46161,7 +46153,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -46221,7 +46213,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -46281,7 +46273,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -46341,7 +46333,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 \"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}" + "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 \"pauseAndResume\": {\n \"enabled\": \"\",\n \"pauseTimeout\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -46395,7 +46387,7 @@ }, "raw": "{\n \"add\": [\n \"\",\n \"\"\n ],\n \"remove\": [\n \"\",\n \"\"\n ]\n}" }, - "description": "This API can be used by a contact center supervisor to add or remove agents to/from an agent based queue that they have access to by virtue of their user profile access rights. Additionally, the request payload should contain the user id(s) managed by the supervisor.", + "description": "This API can be used by a contact center supervisor to add or remove agents to or from an agent-based queue that they can access through their user profile access rights. Additionally, the request payload should contain the user ID(s) managed by the supervisor.", "header": [ { "key": "Content-Type", @@ -46742,7 +46734,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{}", + "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -46865,9 +46857,9 @@ ] }, { - "name": "List Contact Service Queue(s)", + "name": "List Contact Service Queues", "request": { - "description": "Retrieve a list of Contact Service Queue(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 Contact Service Queues 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. Deprecated. Use GET /v2/contact-service-queue instead.", "header": [ { "key": "Accept", @@ -46917,12 +46909,12 @@ "value": "false" }, { - "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.", + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -47000,12 +46992,12 @@ "value": "false" }, { - "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.", + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -47083,12 +47075,12 @@ "value": "false" }, { - "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.", + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -47166,12 +47158,12 @@ "value": "false" }, { - "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.", + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -47249,12 +47241,12 @@ "value": "false" }, { - "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.", + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -47332,12 +47324,12 @@ "value": "false" }, { - "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.", + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -47415,12 +47407,12 @@ "value": "false" }, { - "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.", + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -47844,7 +47836,7 @@ }, { "_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}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": \"\"\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": [ @@ -48023,7 +48015,7 @@ "response": [ { "_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}", + "body": "{\n \"meta\": {\n \"key_0\": false,\n \"key_1\": 1615,\n \"key_2\": 4563.909627876901\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": [ @@ -48988,7 +48980,7 @@ ] }, { - "name": "List CSQs by Skills and Profile", + "name": "List skill-based Contact Service Queues by dynamic skills and skill profile", "request": { "body": { "mode": "raw", @@ -49000,7 +48992,7 @@ }, "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.", + "description": "Retrieve a list of skill-based Contact Service Queues that match the given dynamic skills and skill profile criteria in a given organization.", "header": [ { "key": "Content-Type", @@ -49371,7 +49363,7 @@ }, { "_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}", + "body": "{\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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": [ @@ -49428,7 +49420,7 @@ ] }, { - "name": "List CSQs by User and Profile", + "name": "List skill-based Contact Service Queues by skill profile ID and user ID", "request": { "body": { "mode": "raw", @@ -49440,7 +49432,7 @@ }, "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 user ID and skill profile ID in a given organization.", + "description": "Retrieve a list of skill-based Contact Service Queues associated with the given skill profile ID and user ID combination in a given organization.", "header": [ { "key": "Content-Type", @@ -49587,7 +49579,7 @@ }, { "_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}", + "body": "{\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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": [ @@ -50059,7 +50051,7 @@ }, { "_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}", + "body": "{\n \"meta\": {\n \"key_0\": false,\n \"key_1\": 1615,\n \"key_2\": 4563.909627876901\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": [ @@ -51717,7 +51709,7 @@ }, { "_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}", + "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": [ @@ -53429,7 +53421,7 @@ { "name": "List 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.", + "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: 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", @@ -53809,7 +53801,7 @@ }, { "_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}", + "body": "{\n \"meta\": {\n \"key_0\": {}\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": [ @@ -53971,9 +53963,9 @@ { "item": [ { - "name": "List Desktop Profile(s)", + "name": "List Desktop Profiles", "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": "Retrieve a list of Desktop Profiles 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. Deprecated. Use GET /v2/agent-profile instead.", "header": [ { "key": "Accept", @@ -53992,12 +53984,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 ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", "key": "attributes", "value": "" }, @@ -54012,7 +54004,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -54059,12 +54051,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 ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", "key": "attributes", "value": "" }, @@ -54079,7 +54071,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -54126,12 +54118,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 ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", "key": "attributes", "value": "" }, @@ -54146,7 +54138,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -54193,12 +54185,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 ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", "key": "attributes", "value": "" }, @@ -54213,7 +54205,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -54231,7 +54223,7 @@ }, { "_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]", + "body": "[\n {\n \"organizationId\": \"e3FaFD3A-ccd9-4cBE9bD1-EBbAf80d3fa6\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"2\u2000l\\rnr5\u180e\",\n \"description\": \"\",\n \"parentType\": \"ORGANIZATION\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"scheduleAndManageCallBack\": \"\",\n \"autoWrapUp\": \"\",\n \"agentPersonalGreeting\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"accessWrapUpCode\": \"SPECIFIC\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"accessIdleCode\": \"ALL\",\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"accessQueue\": \"NONE\",\n \"accessEntryPoint\": \"ALL\",\n \"accessBuddyTeam\": \"ALL\",\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 \"manageChannelAvailability\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"agentDNValidationCriteria\": \"ALL\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"EXTENSION\",\n \"AGENT_DN\"\n ],\n \"active\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"autoAcceptDigitalInteractions\": \"\"\n },\n {\n \"organizationId\": \"C4C00bdA-8fff-67eC-Ac1b-5AA7fC85D20C\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"9.\u2004XX\u202f\\u000b\u180e\u1680M\",\n \"description\": \"\",\n \"parentType\": \"SITE\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"scheduleAndManageCallBack\": \"\",\n \"autoWrapUp\": \"\",\n \"agentPersonalGreeting\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"accessWrapUpCode\": \"ALL\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"accessIdleCode\": \"PROVISIONED_VALUE\",\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"accessQueue\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessBuddyTeam\": \"PROVISIONED_VALUE\",\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 \"manageChannelAvailability\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"active\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"autoAcceptDigitalInteractions\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -54260,12 +54252,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 ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", "key": "attributes", "value": "" }, @@ -54280,7 +54272,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -54327,12 +54319,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 ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", "key": "attributes", "value": "" }, @@ -54347,7 +54339,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -54394,12 +54386,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 ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", "key": "attributes", "value": "" }, @@ -54414,7 +54406,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -54447,13 +54439,13 @@ }, "description": "Create a new Desktop Profile in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" + }, + { + "key": "Content-Type", + "value": "application/json" } ], "method": "POST", @@ -54466,7 +54458,264 @@ ":orgid", "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile", + "query": [ + { + "description": "Agent profile configuration data", + "key": "accessBuddyTeam", + "value": "NONE" + }, + { + "description": "Agent profile configuration data", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -54502,11 +54751,11 @@ }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -54520,7 +54769,264 @@ ":orgid", "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile", + "query": [ + { + "description": "Agent profile configuration data", + "key": "accessBuddyTeam", + "value": "NONE" + }, + { + "description": "Agent profile configuration data", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -54556,11 +55062,11 @@ }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -54574,7 +55080,264 @@ ":orgid", "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile", + "query": [ + { + "description": "Agent profile configuration data", + "key": "accessBuddyTeam", + "value": "NONE" + }, + { + "description": "Agent profile configuration data", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -54610,11 +55373,11 @@ }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -54628,7 +55391,264 @@ ":orgid", "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile", + "query": [ + { + "description": "Agent profile configuration data", + "key": "accessBuddyTeam", + "value": "NONE" + }, + { + "description": "Agent profile configuration data", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -54641,7 +55661,7 @@ }, { "_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}", + "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 \"scheduleAndManageCallBack\": \"\",\n \"autoWrapUp\": \"\",\n \"agentPersonalGreeting\": \"\",\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 \"manageChannelAvailability\": \"\",\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 \"autoAcceptDigitalInteractions\": \"\"\n}", "code": 201, "cookie": [], "header": [ @@ -54663,13 +55683,13 @@ "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": "*/*" + }, + { + "key": "Content-Type", + "value": "application/json" } ], "method": "POST", @@ -54682,7 +55702,264 @@ ":orgid", "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile", + "query": [ + { + "description": "Agent profile configuration data", + "key": "accessBuddyTeam", + "value": "NONE" + }, + { + "description": "Agent profile configuration data", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -54718,11 +55995,11 @@ }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -54736,7 +56013,264 @@ ":orgid", "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile", + "query": [ + { + "description": "Agent profile configuration data", + "key": "accessBuddyTeam", + "value": "NONE" + }, + { + "description": "Agent profile configuration data", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -54772,11 +56306,11 @@ }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -54790,7 +56324,264 @@ ":orgid", "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile", + "query": [ + { + "description": "Agent profile configuration data", + "key": "accessBuddyTeam", + "value": "NONE" + }, + { + "description": "Agent profile configuration data", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -54826,11 +56617,11 @@ }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -54844,83 +56635,340 @@ ":orgid", "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile", - "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": "Forbidden" - } - ] - }, - { - "name": "Bulk save Desktop Profile(s)", - "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.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "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", - "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", + "description": "Agent profile configuration data", + "key": "accessBuddyTeam", + "value": "NONE" + }, + { + "description": "Agent profile configuration data", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", + "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 Desktop Profiles", + "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 Profiles in bulk in a given organization.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "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", + "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" } }, @@ -55655,9 +57703,9 @@ ] }, { - "name": "Purge inactive Desktop Profile(s)", + "name": "Purge inactive Desktop Profiles", "request": { - "description": "Purge inactive Desktop Profile(s) older than the configured interval for a given organization.", + "description": "Purge inactive Desktop Profiles older than the configured interval for a given organization.", "header": [ { "key": "Accept", @@ -55677,7 +57725,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -55725,7 +57773,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -55773,7 +57821,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -55821,7 +57869,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -55869,7 +57917,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -55917,55 +57965,55 @@ ], "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.", - "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", - "agent-profile", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will 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.", + "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", + "agent-profile", + "purge-inactive-entities" + ], + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -55983,7 +58031,7 @@ }, { "_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}", + "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": [ @@ -56013,7 +58061,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -56250,7 +58298,7 @@ }, { "_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}", + "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 \"scheduleAndManageCallBack\": \"\",\n \"autoWrapUp\": \"\",\n \"agentPersonalGreeting\": \"\",\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 \"manageChannelAvailability\": \"\",\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 \"autoAcceptDigitalInteractions\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -56355,13 +58403,13 @@ }, "description": "Update an existing Desktop 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", @@ -56375,7 +58423,264 @@ "agent-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "query": [ + { + "description": "Agent profile configuration data for update", + "key": "accessBuddyTeam", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data for update", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data for update", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data for update", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data for update", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data for update", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56416,11 +58721,11 @@ }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -56435,7 +58740,264 @@ "agent-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "query": [ + { + "description": "Agent profile configuration data for update", + "key": "accessBuddyTeam", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data for update", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data for update", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data for update", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data for update", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data for update", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56475,11 +59037,11 @@ }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -56494,7 +59056,264 @@ "agent-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "query": [ + { + "description": "Agent profile configuration data for update", + "key": "accessBuddyTeam", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data for update", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data for update", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data for update", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data for update", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data for update", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56511,7 +59330,7 @@ }, { "_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}", + "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 \"scheduleAndManageCallBack\": \"\",\n \"autoWrapUp\": \"\",\n \"agentPersonalGreeting\": \"\",\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 \"manageChannelAvailability\": \"\",\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 \"autoAcceptDigitalInteractions\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -56533,13 +59352,13 @@ "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": "*/*" + }, + { + "key": "Content-Type", + "value": "application/json" } ], "method": "PUT", @@ -56553,7 +59372,264 @@ "agent-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "query": [ + { + "description": "Agent profile configuration data for update", + "key": "accessBuddyTeam", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data for update", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data for update", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data for update", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data for update", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data for update", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56593,11 +59669,11 @@ }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -56612,7 +59688,264 @@ "agent-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "query": [ + { + "description": "Agent profile configuration data for update", + "key": "accessBuddyTeam", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data for update", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data for update", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data for update", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data for update", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data for update", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56652,11 +59985,11 @@ }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -56671,7 +60004,264 @@ "agent-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "query": [ + { + "description": "Agent profile configuration data for update", + "key": "accessBuddyTeam", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data for update", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data for update", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data for update", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data for update", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data for update", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56711,11 +60301,11 @@ }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -56730,20 +60320,277 @@ "agent-profile", ":id" ], - "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": "Agent profile configuration data for update", + "key": "accessBuddyTeam", + "value": "NONE" }, { - "description": "Resource ID of the Desktop Profile.", - "key": "id" - } - ] - } - }, - "status": "Too Many Requests" + "description": "Agent profile configuration data for update", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data for update", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data for update", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data for update", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data for update", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data for update", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", + "variable": [ + { + "description": "Organization ID to 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" }, { "_postman_previewlanguage": "json", @@ -56770,11 +60617,11 @@ }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -56789,7 +60636,264 @@ "agent-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "query": [ + { + "description": "Agent profile configuration data for update", + "key": "accessBuddyTeam", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data for update", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data for update", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data for update", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data for update", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data for update", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56829,11 +60933,11 @@ }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -56848,7 +60952,264 @@ "agent-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "query": [ + { + "description": "Agent profile configuration data for update", + "key": "accessBuddyTeam", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessEntryPoint", + "value": "NONE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessIdleCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessQueue", + "value": "PROVISIONED_VALUE" + }, + { + "description": "Agent profile configuration data for update", + "key": "accessWrapUpCode", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidation", + "value": "ALL" + }, + { + "description": "Agent profile configuration data for update", + "key": "name", + "value": ".\ufeffw9I\u2028MfdC" + }, + { + "description": "Agent profile configuration data for update", + "key": "parentType", + "value": "SITE" + }, + { + "description": "Agent profile configuration data for update", + "key": "viewableStatistics", + "value": "[object Object]" + }, + { + "description": "Agent profile configuration data for update", + "key": "organizationId", + "value": "FbA87a372EEa-8539-d0bB-cB2a8576AecA" + }, + { + "description": "Agent profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "siteId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "screenPopup", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastAgentRouting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "scheduleAndManageCallBack", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapUp", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAnswer", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentPersonalGreeting", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoWrapAfterSeconds", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentAvailableAfterOutdial", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "allowAutoWrapUpExtension", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "wrapUpCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "idleCodes", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "queues", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "entryPoints", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "buddyTeams", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "consultToQueue", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialEntryPointId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "outdialANIId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "addressBookId", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlanEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "dialPlans", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriteria", + "value": "SPECIFIC" + }, + { + "description": "Agent profile configuration data for update", + "key": "agentDNValidationCriterions", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "loginVoiceOptions", + "value": "BROWSER,BROWSER" + }, + { + "description": "Agent profile configuration data for update", + "key": "thresholdRules", + "value": "," + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityCustomEnabled", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationMS", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "showUserDetailsWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "stateSynchronizationWebex", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "manageChannelAvailability", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "timeoutDesktopInactivityMins", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "systemDefault", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + }, + { + "description": "Agent profile configuration data for update", + "key": "autoAcceptDigitalInteractions", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id?accessBuddyTeam=NONE&accessEntryPoint=NONE&accessIdleCode=SPECIFIC&accessQueue=PROVISIONED_VALUE&accessWrapUpCode=SPECIFIC&active=&agentDNValidation=ALL&name=.\ufeffw9I\u2028MfdC&parentType=SITE&viewableStatistics=[object Object]&organizationId=FbA87a372EEa-8539-d0bB-cB2a8576AecA&id=&version=&description=&siteId=&screenPopup=&lastAgentRouting=&scheduleAndManageCallBack=&autoWrapUp=&autoAnswer=&agentPersonalGreeting=&autoWrapAfterSeconds=&agentAvailableAfterOutdial=&allowAutoWrapUpExtension=&wrapUpCodes=,&idleCodes=,&queues=,&entryPoints=,&buddyTeams=,&consultToQueue=&outdialEnabled=&outdialEntryPointId=&outdialANIId=&addressBookId=&dialPlanEnabled=&dialPlans=,&agentDNValidationCriteria=SPECIFIC&agentDNValidationCriterions=,&loginVoiceOptions=BROWSER,BROWSER&thresholdRules=,&timeoutDesktopInactivityCustomEnabled=&showUserDetailsMS=&stateSynchronizationMS=&showUserDetailsWebex=&stateSynchronizationWebex=&manageChannelAvailability=&timeoutDesktopInactivityMins=&systemDefault=&createdTime=&lastUpdatedTime=&autoAcceptDigitalInteractions=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -57645,9 +62006,9 @@ ] }, { - "name": "List Desktop Profile(s)", + "name": "List Desktop Profiles", "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": "Retrieve a list of Desktop Profiles 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", @@ -57667,12 +62028,12 @@ ], "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", + "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 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 ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", "key": "attributes", "value": "" }, @@ -57692,12 +62053,17 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile.", + "key": "provisioningView", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?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.", @@ -57740,12 +62106,12 @@ ], "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", + "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 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 ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", "key": "attributes", "value": "" }, @@ -57765,12 +62131,17 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile.", + "key": "provisioningView", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?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.", @@ -57813,12 +62184,12 @@ ], "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", + "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 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 ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", "key": "attributes", "value": "" }, @@ -57838,12 +62209,17 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile.", + "key": "provisioningView", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?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.", @@ -57886,12 +62262,12 @@ ], "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", + "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 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 ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", "key": "attributes", "value": "" }, @@ -57911,12 +62287,17 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile.", + "key": "provisioningView", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?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.", @@ -57959,12 +62340,12 @@ ], "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", + "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 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 ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", "key": "attributes", "value": "" }, @@ -57984,12 +62365,17 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile.", + "key": "provisioningView", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?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.", @@ -58032,12 +62418,12 @@ ], "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", + "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 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 ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", "key": "attributes", "value": "" }, @@ -58057,12 +62443,17 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile.", + "key": "provisioningView", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?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.", @@ -58105,12 +62496,12 @@ ], "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", + "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 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 ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", "key": "attributes", "value": "" }, @@ -58130,12 +62521,17 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "If set to true, the API will only return data that the user has access to, according to the User Profile.", + "key": "provisioningView", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?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.", @@ -58456,7 +62852,7 @@ }, { "_postman_previewlanguage": "text", - "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]", + "body": "[\n {\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"Fbacd5Ec-7996-9cfB1bC3-E7E7b06b31C6\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"8850128070\",\n \"extension\": \"018446530\",\n \"routingPrefix\": \"979734\",\n \"esn\": \"8042034007\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n },\n {\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"7fBD2dCe-6bbA-BcDaaD2C76a835c7A186\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"3974840-\",\n \"extension\": \"5605104479\",\n \"routingPrefix\": \"284375\",\n \"esn\": \"413724402514\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -62210,7 +66606,7 @@ }, { "_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}", + "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, "cookie": [], "header": [ @@ -62716,7 +67112,7 @@ }, { "_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}", + "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, "cookie": [], "header": [ @@ -63018,9 +67414,9 @@ { "item": [ { - "name": "List Dial Plan(s)", + "name": "List Dial Plans", "request": { - "description": "Retrieve a list of Dial Plan(s) in a given organization.", + "description": "Retrieve a list of Dial Plans in a given organization.\n\n**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.", "header": [ { "key": "Accept", @@ -63039,12 +67435,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", + "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": "" }, @@ -63101,12 +67497,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", + "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": "" }, @@ -63163,12 +67559,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", + "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": "" }, @@ -63225,12 +67621,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", + "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": "" }, @@ -63287,12 +67683,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", + "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": "" }, @@ -63320,7 +67716,7 @@ }, { "_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]", + "body": "[\n {\n \"active\": \"\",\n \"name\": \"\u205fe\\fmh\u2001\u2007\",\n \"regularExpression\": \"\",\n \"organizationId\": \"cfA931Eb-2DDfA0f7-54cc6BdCCcFDBaAC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"name\": \"o\u200ao\",\n \"regularExpression\": \"\",\n \"organizationId\": \"948F4Bcf-C9aB-3f66-Ddc6-5c2af6039CCB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -63349,12 +67745,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", + "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": "" }, @@ -63411,12 +67807,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", + "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": "" }, @@ -63455,9 +67851,9 @@ "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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, - "description": "Create a new Dial Plan in a given organization.", + "description": "Create a new Dial Plan in a given organization.\n\n**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.", "header": [ { "key": "Content-Type", @@ -63510,7 +67906,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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -63564,7 +67960,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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -63618,7 +68014,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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -63672,7 +68068,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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -63726,7 +68122,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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -63780,7 +68176,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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -63834,7 +68230,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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -63870,7 +68266,7 @@ ] }, { - "name": "Bulk save Dial Plan(s)", + "name": "Bulk save Dial Plans", "request": { "body": { "mode": "raw", @@ -63882,7 +68278,7 @@ }, "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": "Create, Update or delete Dial Plans in bulk in a given organization.\n\n**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.", "header": [ { "key": "Content-Type", @@ -64669,7 +69065,7 @@ { "name": "Get specific Dial Plan by ID", "request": { - "description": "Retrieve an existing Dial Plan by ID in a given organization.", + "description": "Retrieve an existing Dial Plan by ID in a given organization.\n\n**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.", "header": [ { "key": "Accept", @@ -64986,9 +69382,9 @@ "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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, - "description": "Update an existing Dial Plan by ID in a given organization.", + "description": "Update an existing Dial Plan by ID in a given organization.\n\n**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.", "header": [ { "key": "Content-Type", @@ -65047,7 +69443,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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -65106,7 +69502,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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -65165,7 +69561,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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -65224,7 +69620,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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -65283,7 +69679,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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -65342,7 +69738,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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -65401,7 +69797,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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -65460,7 +69856,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 \"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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -65503,7 +69899,7 @@ { "name": "Delete specific Dial Plan by ID", "request": { - "description": "Delete an existing Dial Plan by ID in a given organization.", + "description": "Delete an existing Dial Plan by ID in a given organization.\n\n**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.", "header": [ { "key": "Accept", @@ -65847,7 +70243,7 @@ { "name": "List references for a specific Dial Plan", "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 Dial Plan by ID in a given organization.\n\n**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.", "header": [ { "key": "Accept", @@ -66280,9 +70676,9 @@ ] }, { - "name": "List Dial Plan(s)", + "name": "List Dial Plans", "request": { - "description": "Retrieve a list of Dial Plan(s) in a given organization.", + "description": "Retrieve a list of Dial Plans in a given organization.\n\n**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.", "header": [ { "key": "Accept", @@ -66302,12 +70698,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": "" }, @@ -66370,12 +70766,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": "" }, @@ -66408,7 +70804,7 @@ }, { "_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}", + "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, "cookie": [], "header": [ @@ -66438,12 +70834,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": "" }, @@ -66506,12 +70902,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": "" }, @@ -66574,12 +70970,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": "" }, @@ -66642,12 +71038,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": "" }, @@ -66710,12 +71106,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": "" }, @@ -67039,7 +71435,7 @@ }, { "_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]", + "body": "[\n {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"OTHERS\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"8egr7Qs\\u000bN8\",\n \"overflowNumber\": \"687684\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSENGER\",\n \"organizationId\": \"6a080ea7E9eF-C775FC9b3F567ecaa4aF\",\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\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"64\u2009\u3000\",\n \"overflowNumber\": \"440581\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"b1c72d3C-745Fb7dAFbac57AEF602F7c1\",\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": [ @@ -68745,7 +73141,7 @@ }, { "_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}", + "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": [ @@ -70632,7 +75028,7 @@ "response": [ { "_postman_previewlanguage": "text", - "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}", + "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, "cookie": [], "header": [ @@ -72428,7 +76824,7 @@ "response": [ { "_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}", + "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": [ @@ -74718,7 +79114,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 \"key_1\": {},\n \"key_2\": {}\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": [ @@ -75372,7 +79768,7 @@ }, { "_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]", + "body": "[\n {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"fiu\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"9BF7C9d80f9e-0fEc-BA20-2CFF916D1B8e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"3dc8FA53-eb41-7D697a2A-3878BF961b0B\",\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\": \"18\u2007q\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"473d9129b2B6e5983A19-Bbf0B675CB2e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"2D4e9d6E-99F8082A-504Ab6BBFe3Ef6a0\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -76869,7 +81265,7 @@ }, { "_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}", + "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": [ @@ -79103,7 +83499,7 @@ }, { "_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}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {}\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": [ @@ -79245,9 +83641,9 @@ { "item": [ { - "name": "List Outdial ANI(s)", + "name": "List Outdial ANIs", "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 ANIs 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", @@ -79286,7 +83682,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -79353,7 +83749,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -79420,7 +83816,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -79487,7 +83883,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -79554,7 +83950,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -79572,7 +83968,7 @@ }, { "_postman_previewlanguage": "text", - "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]", + "body": "[\n {\n \"organizationId\": \"3ABCCcda-dBfe-eF7DabD6C8cfE8ea5CCc\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"zJtazWsu\",\n \"description\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"f7CeBee7-4eAF-a4Ee-147c3D0D75FCaEbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\u2007To\",\n \"description\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -79621,7 +84017,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -79688,7 +84084,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -80132,7 +84528,7 @@ ] }, { - "name": "Bulk save Outdial ANI(s)", + "name": "Bulk save Outdial ANIs", "request": { "body": { "mode": "raw", @@ -80144,7 +84540,7 @@ }, "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": "Create, Update or delete Outdial ANI(s) in bulk in a given organization.", + "description": "Create, Update or delete Outdial ANIs in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -80929,9 +85325,9 @@ ] }, { - "name": "List Outdial ANI Entry(s)", + "name": "List Outdial ANI Entries", "request": { - "description": "Retrieve a list of Outdial ANI Entry(s) in a given organization.", + "description": "Retrieve a list of Outdial ANI Entries in a given organization.", "header": [ { "key": "Accept", @@ -81125,7 +85521,7 @@ }, { "_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}", + "body": "{\n \"meta\": {\n \"key_0\": {}\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": [ @@ -83485,7 +87881,7 @@ ] }, { - "name": "Bulk save Outdial ANI Entry(s)", + "name": "Bulk save Outdial ANI Entries", "request": { "body": { "mode": "raw", @@ -83497,7 +87893,7 @@ }, "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": "Create, Update or delete Outdial ANI Entries in bulk for an Address Book in a given organization.", "header": [ { "key": "Content-Type", @@ -85292,9 +89688,9 @@ ] }, { - "name": "List Outdial ANI(s)", + "name": "List Outdial ANIs", "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 ANIs 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", @@ -85339,7 +89735,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -85357,7 +89753,7 @@ "response": [ { "_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}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\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": [ @@ -85412,7 +89808,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -85485,7 +89881,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -85558,7 +89954,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -85631,7 +90027,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -85704,7 +90100,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -85777,7 +90173,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -85796,9 +90192,9 @@ ] }, { - "name": "List Outdial ANI Entry(s)", + "name": "List Outdial ANI Entries", "request": { - "description": "Retrieve a list of Outdial ANI Entry(s) in a given organization.", + "description": "Retrieve a list of Outdial ANI Entries in a given organization.", "header": [ { "key": "Accept", @@ -85937,7 +90333,7 @@ }, { "_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}", + "body": "{\n \"meta\": {\n \"key_0\": {}\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": [ @@ -86565,7 +90961,7 @@ }, { "_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]", + "body": "[\n {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"y9\u202fw\\u000bdG\",\n \"organizationId\": \"c5aBCDFE7B64E304-f43689Db4A7F3790\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"M\\rd\u3000lLoN\u180e\",\n \"organizationId\": \"0F2eA17dfDD419D6-2D0b-CA2839225a21\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -87932,7 +92328,7 @@ "response": [ { "_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}", + "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": [ @@ -90010,7 +94406,7 @@ }, { "_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}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {}\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": [ @@ -90356,9 +94752,9 @@ { "item": [ { - "name": "List Skill(s)", + "name": "List Skills", "request": { - "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.", + "description": "Retrieve a list of Skills 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. Deprecated. Use GET /v2/skill instead.", "header": [ { "key": "Accept", @@ -90397,7 +94793,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -90464,7 +94860,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -90531,7 +94927,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -90598,7 +94994,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -90665,7 +95061,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -90732,7 +95128,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -90750,7 +95146,7 @@ }, { "_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]", + "body": "[\n {\n \"active\": \"\",\n \"name\": \"vs\u2008\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"Eb3bffc3ba6D0cBA25ea-67DfE63fcc3a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"ZzU67\",\n \"organizationId\": \"cFB9a7f37dcF439D-c1bE-1BA9BBa0d0EE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\ufeff\u2002nD\u2009\u2004zV\",\n \"organizationId\": \"38EB147Fe6Bc6E99472Dd4A4E1754946\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"name\": \"Yr9mrfn\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Boolean\",\n \"organizationId\": \"142D7cfa-2DaaCaf5-0BDC-b127cAeBaE5E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u180ed\u2006\u1680lik\u2007M4\",\n \"organizationId\": \"C43C29eC08aE-D7D1-a308-7D9ba567C6BB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \".P\u2005d1fIZy\u3000\",\n \"organizationId\": \"Eecd0DDB-aEFe-dF3661EcC6847EE13dcD\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -90799,7 +95195,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -90828,17 +95224,17 @@ "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}" + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "description": "Create a new Skill in a given organization.", "header": [ - { - "key": "Accept", - "value": "*/*" - }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" } ], "method": "POST", @@ -90851,69 +95247,7 @@ ":orgid", "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?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", + "raw": "{{baseUrl}}/organization/:orgid/skill", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -90926,7 +95260,7 @@ "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 \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 201, "cookie": [], "header": [ @@ -90945,16 +95279,16 @@ "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}" + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ - { - "key": "Accept", - "value": "*/*" - }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" } ], "method": "POST", @@ -90967,69 +95301,7 @@ ":orgid", "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?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", + "raw": "{{baseUrl}}/organization/:orgid/skill", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91061,15 +95333,15 @@ "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}" + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" }, { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], @@ -91083,69 +95355,7 @@ ":orgid", "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?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", + "raw": "{{baseUrl}}/organization/:orgid/skill", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91177,15 +95387,15 @@ "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}" + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" }, { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], @@ -91199,69 +95409,7 @@ ":orgid", "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?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", + "raw": "{{baseUrl}}/organization/:orgid/skill", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91293,15 +95441,15 @@ "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}" + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" }, { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], @@ -91315,69 +95463,7 @@ ":orgid", "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?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", + "raw": "{{baseUrl}}/organization/:orgid/skill", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91409,15 +95495,15 @@ "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}" + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" }, { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], @@ -91431,69 +95517,7 @@ ":orgid", "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?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", + "raw": "{{baseUrl}}/organization/:orgid/skill", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91525,15 +95549,15 @@ "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}" + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" }, { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], @@ -91547,69 +95571,7 @@ ":orgid", "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?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", + "raw": "{{baseUrl}}/organization/:orgid/skill", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91641,15 +95603,15 @@ "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}" + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" }, { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], @@ -91663,69 +95625,7 @@ ":orgid", "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?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", + "raw": "{{baseUrl}}/organization/:orgid/skill", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91739,7 +95639,7 @@ ] }, { - "name": "Bulk save Skill(s)", + "name": "Bulk save Skills", "request": { "body": { "mode": "raw", @@ -91751,7 +95651,7 @@ }, "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(s) in bulk in a given organization.", + "description": "Create, Update or delete Skills in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -92536,9 +96436,9 @@ ] }, { - "name": "Purge inactive Skill(s)", + "name": "Purge inactive Skills", "request": { - "description": "Purge inactive Skill(s) older than the configured interval for a given organization.", + "description": "Purge inactive Skills older than the configured interval for a given organization.", "header": [ { "key": "Accept", @@ -92558,7 +96458,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -92606,7 +96506,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -92654,7 +96554,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -92702,7 +96602,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -92750,7 +96650,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -92798,7 +96698,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -92816,7 +96716,7 @@ }, { "_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}", + "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": [ @@ -92846,7 +96746,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -92894,7 +96794,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -93086,7 +96986,7 @@ }, { "_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}", + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -93232,17 +97132,17 @@ "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}" + "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 \"systemDefault\": \"\",\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" + }, + { + "key": "Accept", + "value": "*/*" } ], "method": "PUT", @@ -93256,69 +97156,7 @@ "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=", + "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.", @@ -93336,7 +97174,7 @@ "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 \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -93355,16 +97193,16 @@ "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}" + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ - { - "key": "Accept", - "value": "*/*" - }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" } ], "method": "PUT", @@ -93378,69 +97216,7 @@ "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=", + "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.", @@ -93476,15 +97252,15 @@ "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}" + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" }, { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], @@ -93499,69 +97275,7 @@ "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=", + "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.", @@ -93597,15 +97311,15 @@ "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}" + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" }, { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], @@ -93620,69 +97334,7 @@ "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=", + "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.", @@ -93718,15 +97370,15 @@ "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}" + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" }, { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], @@ -93741,69 +97393,7 @@ "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=", + "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.", @@ -93839,15 +97429,15 @@ "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}" + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" }, { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], @@ -93862,69 +97452,7 @@ "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=", + "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.", @@ -93960,15 +97488,15 @@ "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}" + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" }, { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], @@ -93983,69 +97511,7 @@ "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=", + "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.", @@ -94081,15 +97547,15 @@ "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}" + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" }, { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], @@ -94104,69 +97570,7 @@ "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=", + "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.", @@ -94202,15 +97606,15 @@ "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}" + "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 \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" }, { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], @@ -94225,69 +97629,7 @@ "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=", + "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.", @@ -95084,9 +98426,9 @@ ] }, { - "name": "List Skill(s)", + "name": "List Skills", "request": { - "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.", + "description": "Retrieve a list of Skills 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", @@ -95131,12 +98473,17 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "Fetch array fields on demand only. Supported array fields are enumSkillValues.", + "key": "include", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false&include=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -95204,12 +98551,17 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "Fetch array fields on demand only. Supported array fields are enumSkillValues.", + "key": "include", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false&include=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -95277,12 +98629,17 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "Fetch array fields on demand only. Supported array fields are enumSkillValues.", + "key": "include", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false&include=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -95350,12 +98707,17 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "Fetch array fields on demand only. Supported array fields are enumSkillValues.", + "key": "include", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false&include=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -95423,12 +98785,17 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "Fetch array fields on demand only. Supported array fields are enumSkillValues.", + "key": "include", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false&include=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -95496,12 +98863,17 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "Fetch array fields on demand only. Supported array fields are enumSkillValues.", + "key": "include", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false&include=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -95514,7 +98886,7 @@ }, { "_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}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": \"\"\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": [ @@ -95569,12 +98941,17 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "Fetch array fields on demand only. Supported array fields are enumSkillValues.", + "key": "include", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false&include=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -96135,7 +99512,7 @@ }, { "_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]", + "body": "[\n {\n \"organizationId\": \"1aEf9EB5a14e-C277f5Eb0B3Fa26cd3f0\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"7xr.r\u2009\",\n \"description\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"5C292a0C-BEAF3768B1c0b9B70aBf3ecD\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -100596,9 +103973,9 @@ { "item": [ { - "name": "List Team(s)", + "name": "List Teams", "request": { - "description": "Retrieve a list of Team(s) in a given organization.", + "description": "Retrieve a list of Teams in a given organization. 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", @@ -100637,7 +104014,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -100704,7 +104081,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -100771,7 +104148,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -100838,7 +104215,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -100905,7 +104282,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -100972,7 +104349,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -100990,7 +104367,7 @@ }, { "_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]", + "body": "[\n {\n \"organizationId\": \"Aa0C58DA-FAEd-9B0d-Cd2c-7aC405B8bafB\",\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\": \"21e95cbe-CAC4-6D03Db36D6C93861081A\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"96A2fD4D-Bd47F8ce-9A8D4e5fee855cD8\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"D929CE6a-82C14a5D83A3-ef84a0cE49CE\",\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\": \"Dac7F0C9-F921FeB8Ad059d9f53ECf6C5\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Aa0bf4ccE5d2-4723-D3BF-151bA0283ec0\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -101039,7 +104416,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -102139,7 +105516,7 @@ ] }, { - "name": "Bulk save Team(s)", + "name": "Bulk save Teams", "request": { "body": { "mode": "raw", @@ -102151,7 +105528,7 @@ }, "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": "Create, Update or delete Teams in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -102936,9 +106313,9 @@ ] }, { - "name": "Purge inactive Team(s)", + "name": "Purge inactive Teams", "request": { - "description": "Purge inactive Team(s) older than the configured interval for a given organization.", + "description": "Purge inactive Teams older than the configured interval for a given organization.", "header": [ { "key": "Accept", @@ -102958,7 +106335,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -103006,7 +106383,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -103054,7 +106431,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -103102,7 +106479,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -103150,7 +106527,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -103168,7 +106545,7 @@ }, { "_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}", + "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": [ @@ -103198,7 +106575,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -103246,7 +106623,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -103294,7 +106671,7 @@ ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", + "description": "This is the entity ID from which items for the next purge batch will be selected.", "key": "nextStartId", "value": "" } @@ -105664,9 +109041,9 @@ ] }, { - "name": "List Team(s)", + "name": "List Teams", "request": { - "description": "Retrieve a list of Team(s) in a given organization.", + "description": "Retrieve a list of Teams in a given organization. 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", @@ -105686,7 +109063,7 @@ ], "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 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. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse the userId field to filter teams associated with the 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": "" }, @@ -105711,17 +109088,17 @@ "value": "100" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile", + "description": "If set to true, the API will only return data that the user has access to, according to the 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.", + "description": "If set to true, the API will only return data that the user has access to, according to the 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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -105769,7 +109146,7 @@ ], "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 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. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse the userId field to filter teams associated with the 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": "" }, @@ -105794,17 +109171,17 @@ "value": "100" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile", + "description": "If set to true, the API will only return data that the user has access to, according to the 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.", + "description": "If set to true, the API will only return data that the user has access to, according to the 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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -105852,7 +109229,7 @@ ], "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 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. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse the userId field to filter teams associated with the 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": "" }, @@ -105877,17 +109254,17 @@ "value": "100" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile", + "description": "If set to true, the API will only return data that the user has access to, according to the 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.", + "description": "If set to true, the API will only return data that the user has access to, according to the 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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -105935,7 +109312,7 @@ ], "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 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. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse the userId field to filter teams associated with the 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": "" }, @@ -105960,17 +109337,17 @@ "value": "100" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile", + "description": "If set to true, the API will only return data that the user has access to, according to the 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.", + "description": "If set to true, the API will only return data that the user has access to, according to the 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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -106018,7 +109395,7 @@ ], "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 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. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse the userId field to filter teams associated with the 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": "" }, @@ -106043,17 +109420,17 @@ "value": "100" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile", + "description": "If set to true, the API will only return data that the user has access to, according to the 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.", + "description": "If set to true, the API will only return data that the user has access to, according to the 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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -106101,7 +109478,7 @@ ], "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 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. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse the userId field to filter teams associated with the 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": "" }, @@ -106126,17 +109503,17 @@ "value": "100" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile", + "description": "If set to true, the API will only return data that the user has access to, according to the 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.", + "description": "If set to true, the API will only return data that the user has access to, according to the 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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -106184,7 +109561,7 @@ ], "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 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. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse the userId field to filter teams associated with the 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": "" }, @@ -106209,17 +109586,17 @@ "value": "100" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile", + "description": "If set to true, the API will only return data that the user has access to, according to the 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.", + "description": "If set to true, the API will only return data that the user has access to, according to the 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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -109860,7 +113237,7 @@ { "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.", + "description": "Retrieve a list of user profiles 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", @@ -110258,7 +113635,7 @@ }, { "_postman_previewlanguage": "text", - "body": "string", + "body": "{\n \"meta\": {\n \"orgid\": \"CEF9e6dD-9Aa7-3Dbd-4795-B3cC9c5B8a0b\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"name\": \"MhF\u00a0W\\u000b\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"EF2D33eBdd6d-637b-805A-7bee6C0dfdFC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"DISABLED\"\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\": \"Uiu\u2009IP\u2007pj\",\n \"organizationId\": \"e144a0fa9bF0-aCF9cC6d-67bCdD8b8aC6\",\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 \"name\": \"p\u2002\u2005Nxw\u20029M\",\n \"organizationId\": \"A7cCd62E-956F2bE5Ecd9-3dFA24aCc549\",\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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"name\": \"\u2002K0Og\u200ac8\u3000\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ANALYZER_USER\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"f338eDc8-563bdD89-0De8C986FDEb89B0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\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\": \"\\rS\u2002w\ufeffIqV\",\n \"organizationId\": \"b33DAC9bdC0F1d24-bc22-DAeCaBCB81EC\",\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\": \"\u2001\",\n \"organizationId\": \"34609F46-fa5A-661B-0BDe7aD9350Aa04b\",\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 \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -113200,9 +116577,9 @@ { "item": [ { - "name": "List User(s)", + "name": "List Users", "request": { - "description": "Retrieve a list of User(s) in a given organization.", + "description": "Retrieve a list of Users in a given organization. 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. Deprecated. Use GET /v2/user instead.", "header": [ { "key": "Accept", @@ -113241,7 +116618,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -113259,7 +116636,7 @@ "response": [ { "_postman_previewlanguage": "json", - "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]", + "body": "[\n {\n \"organizationId\": \"A1B2Fd0d475a-d7DcCbb17eEff2c57eeB\",\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\": \"ALL\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"NONE\",\n \"accessAllTeams\": \"SPECIFIC\",\n \"active\": \"\",\n \"name\": \"C\\n\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"organizationId\": \"a255DA73e6d4B0DA-aEae-f85AadaA23Ac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"4e44aEb2-dB58-Bf72-1efEaD75f8E6756D\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"7F137cA3-7F43fE03-ff72FD7F0160D4a4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"ADE657b1-F5A1-F88D973C-ee5C20133f85\",\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\": \"AbdEb0da-BD92-894e-aA0D-FDF8dd0B990c\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"f5E5aeb0-a9056aEC8c6a80BCA18ccCFf\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"7a3CBEA48a0E-B588-cf2b-ED240AfF2b74\",\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\": \"f\u2009r\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"4dE02f32-AaF51F5Ad1Fe8bAAf3d6bCd7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\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\": \"a9W6gL8\u00a0aZ0\",\n \"organizationId\": \"F36DfcB4-2d4BecABB38d-a1e427BAE0d6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\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\": \"msD1\u2002Y6jv4\",\n \"organizationId\": \"eE176b71-ffB9-4ee4d7DD2076292f9b5F\",\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\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"EXCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"8F9779F7-C574b4dC-25Fb-cA25A9cecDCb\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumValue\": \"\",\n \"enumSkillValues\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"e013D176-eeeCd33A-26e0cA8e9b3A9e7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumValue\": \"\",\n \"enumSkillValues\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkillsLimitReached\": \"\",\n \"dynamicSkillsUpdatedBy\": \"\",\n \"dynamicSkillsUpdatedTime\": \"\",\n \"dynamicSkillAssigned\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"e3fe94eC-576C-D67C-EA5f-A9bAD97DA8f8\",\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\": \"ALL\",\n \"accessAllTeams\": \"SPECIFIC\",\n \"active\": \"\",\n \"name\": \"PALGW\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"6Ad64d78-B24a-6BfA-BBf4FA5Cb4ECdb71\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"F8B2a3F2-F2D7e4cc-d7B6B81b9aB7FBc1\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"0F0fe96e9F3aa4D4765C-Cbc1efd1A5f0\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"EeB70aA6-9e8fDf9D-ED9c-033BfE8F3807\",\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\": \"fc0edBDf-820b-44Cc-c2e3-E4A60a54f844\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"BcEA3E0f-580d43aCE7FeDC99be90D509\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"BfFe90AB-4d19-8F5fDf2E-BB8F9D3b0bE8\",\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\": \"it\ufefffoz\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"E8930FA5ebAB0e8e-eB40-5f8Fba4B64C6\",\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\": \"8i\u2003J\",\n \"organizationId\": \"B7ebA9A4B48c57F1EA02Ddb4CeeaEFbA\",\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\": \"eWd2f\",\n \"organizationId\": \"FA388a3d-D0EC-Bdc6-ebD0-89F3581cb90f\",\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\": \"EXCLUDED\",\n \"userLevelAutoCSATInclusion\": \"EXCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"EXCLUDED\",\n \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"B9aa92a2-9EcC-D02f5e89-f80bDB365A8a\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumValue\": \"\",\n \"enumSkillValues\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"2213F18a36CF-0Ea07DE3d3bDf0bAeF2B\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumValue\": \"\",\n \"enumSkillValues\": \"\",\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": [ @@ -113308,7 +116685,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -113375,7 +116752,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -113442,7 +116819,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -113509,7 +116886,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -113576,7 +116953,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -113643,7 +117020,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" } @@ -114461,7 +117838,7 @@ { "name": "Get specific User by CI User ID", "request": { - "description": "Retrieve an existing User using the CI ID in a given organization.", + "description": "Retrieve an existing User using the CI ID in a given organization. Deprecated. Use GET /v2/user/by-ci-user-id/{id} instead.", "header": [ { "key": "Accept", @@ -114485,9 +117862,14 @@ "description": "Specifiy whether to include user profile data", "key": "includeUserProfile", "value": "" + }, + { + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", + "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -114539,9 +117921,14 @@ "description": "Specifiy whether to include user profile data", "key": "includeUserProfile", "value": "" + }, + { + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", + "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -114592,9 +117979,14 @@ "description": "Specifiy whether to include user profile data", "key": "includeUserProfile", "value": "" + }, + { + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", + "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -114645,9 +118037,14 @@ "description": "Specifiy whether to include user profile data", "key": "includeUserProfile", "value": "" + }, + { + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", + "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -114698,9 +118095,14 @@ "description": "Specifiy whether to include user profile data", "key": "includeUserProfile", "value": "" + }, + { + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", + "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -114751,9 +118153,14 @@ "description": "Specifiy whether to include user profile data", "key": "includeUserProfile", "value": "" + }, + { + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", + "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -114770,7 +118177,7 @@ }, { "_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 \"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}", + "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 \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\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": [ @@ -114804,9 +118211,14 @@ "description": "Specifiy whether to include user profile data", "key": "includeUserProfile", "value": "" + }, + { + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", + "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -114834,7 +118246,7 @@ "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}" + "raw": "{\n \"skillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"da74a0c2BCce-acE3-A8cfD8a8DCC54FCE\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E1ED851Ffe77-1dDAf15501E1ff7aC25C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\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.", "header": [ @@ -114907,7 +118319,7 @@ "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}" + "raw": "{\n \"skillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"da74a0c2BCce-acE3-A8cfD8a8DCC54FCE\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E1ED851Ffe77-1dDAf15501E1ff7aC25C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}" }, "header": [ { @@ -114979,7 +118391,7 @@ "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}" + "raw": "{\n \"skillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"da74a0c2BCce-acE3-A8cfD8a8DCC54FCE\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E1ED851Ffe77-1dDAf15501E1ff7aC25C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}" }, "header": [ { @@ -115051,7 +118463,7 @@ "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}" + "raw": "{\n \"skillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"da74a0c2BCce-acE3-A8cfD8a8DCC54FCE\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E1ED851Ffe77-1dDAf15501E1ff7aC25C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}" }, "header": [ { @@ -115123,7 +118535,7 @@ "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}" + "raw": "{\n \"skillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"da74a0c2BCce-acE3-A8cfD8a8DCC54FCE\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E1ED851Ffe77-1dDAf15501E1ff7aC25C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}" }, "header": [ { @@ -115195,7 +118607,7 @@ "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}" + "raw": "{\n \"skillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"da74a0c2BCce-acE3-A8cfD8a8DCC54FCE\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E1ED851Ffe77-1dDAf15501E1ff7aC25C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}" }, "header": [ { @@ -115267,7 +118679,7 @@ "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}" + "raw": "{\n \"skillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"da74a0c2BCce-acE3-A8cfD8a8DCC54FCE\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E1ED851Ffe77-1dDAf15501E1ff7aC25C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}" }, "header": [ { @@ -115339,7 +118751,7 @@ "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}" + "raw": "{\n \"skillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"da74a0c2BCce-acE3-A8cfD8a8DCC54FCE\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E1ED851Ffe77-1dDAf15501E1ff7aC25C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}" }, "header": [ { @@ -115393,7 +118805,7 @@ ] }, { - "name": "Fetch User details by IDs", + "name": "List Users with details", "request": { "body": { "mode": "raw", @@ -115452,7 +118864,7 @@ "response": [ { "_postman_previewlanguage": "json", - "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}", + "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, "cookie": [], "header": [ @@ -115924,7 +119336,7 @@ { "name": "List Users along with profile", "request": { - "description": "Retrieve a list of User(s) along with their UserProfiles in a given organization.", + "description": "Retrieve a list of Users along with their User Profiles in a given organization.", "header": [ { "key": "Accept", @@ -115955,7 +119367,7 @@ "response": [ { "_postman_previewlanguage": "json", - "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]", + "body": "[\n {\n \"organizationId\": \"A1B2Fd0d475a-d7DcCbb17eEff2c57eeB\",\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\": \"ALL\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"NONE\",\n \"accessAllTeams\": \"SPECIFIC\",\n \"active\": \"\",\n \"name\": \"C\\n\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"organizationId\": \"a255DA73e6d4B0DA-aEae-f85AadaA23Ac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"4e44aEb2-dB58-Bf72-1efEaD75f8E6756D\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"7F137cA3-7F43fE03-ff72FD7F0160D4a4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"ADE657b1-F5A1-F88D973C-ee5C20133f85\",\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\": \"AbdEb0da-BD92-894e-aA0D-FDF8dd0B990c\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"f5E5aeb0-a9056aEC8c6a80BCA18ccCFf\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"7a3CBEA48a0E-B588-cf2b-ED240AfF2b74\",\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\": \"f\u2009r\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"4dE02f32-AaF51F5Ad1Fe8bAAf3d6bCd7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\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\": \"a9W6gL8\u00a0aZ0\",\n \"organizationId\": \"F36DfcB4-2d4BecABB38d-a1e427BAE0d6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\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\": \"msD1\u2002Y6jv4\",\n \"organizationId\": \"eE176b71-ffB9-4ee4d7DD2076292f9b5F\",\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\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"EXCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"8F9779F7-C574b4dC-25Fb-cA25A9cecDCb\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumValue\": \"\",\n \"enumSkillValues\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"e013D176-eeeCd33A-26e0cA8e9b3A9e7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumValue\": \"\",\n \"enumSkillValues\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkillsLimitReached\": \"\",\n \"dynamicSkillsUpdatedBy\": \"\",\n \"dynamicSkillsUpdatedTime\": \"\",\n \"dynamicSkillAssigned\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"e3fe94eC-576C-D67C-EA5f-A9bAD97DA8f8\",\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\": \"ALL\",\n \"accessAllTeams\": \"SPECIFIC\",\n \"active\": \"\",\n \"name\": \"PALGW\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"6Ad64d78-B24a-6BfA-BBf4FA5Cb4ECdb71\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"F8B2a3F2-F2D7e4cc-d7B6B81b9aB7FBc1\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"0F0fe96e9F3aa4D4765C-Cbc1efd1A5f0\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"EeB70aA6-9e8fDf9D-ED9c-033BfE8F3807\",\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\": \"fc0edBDf-820b-44Cc-c2e3-E4A60a54f844\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"BcEA3E0f-580d43aCE7FeDC99be90D509\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"BfFe90AB-4d19-8F5fDf2E-BB8F9D3b0bE8\",\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\": \"it\ufefffoz\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"E8930FA5ebAB0e8e-eB40-5f8Fba4B64C6\",\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\": \"8i\u2003J\",\n \"organizationId\": \"B7ebA9A4B48c57F1EA02Ddb4CeeaEFbA\",\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\": \"eWd2f\",\n \"organizationId\": \"FA388a3d-D0EC-Bdc6-ebD0-89F3581cb90f\",\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\": \"EXCLUDED\",\n \"userLevelAutoCSATInclusion\": \"EXCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"EXCLUDED\",\n \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"B9aa92a2-9EcC-D02f5e89-f80bDB365A8a\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumValue\": \"\",\n \"enumSkillValues\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"2213F18a36CF-0Ea07DE3d3bDf0bAeF2B\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumValue\": \"\",\n \"enumSkillValues\": \"\",\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": [ @@ -116204,7 +119616,7 @@ { "name": "Get specific User along with profile by ID", "request": { - "description": "Retrieve an existing User along with the corresponding UserProfile by ID in a given organization.", + "description": "Retrieve an existing User along with the corresponding User Profile by ID in a given organization.", "header": [ { "key": "Accept", @@ -116471,7 +119883,7 @@ }, { "_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 \"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}", + "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 \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\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": [ @@ -116540,12 +119952,12 @@ ], "query": [ { - "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", + "description": "If set to true, the API response will include the count of each type of Contact Service Queue to which the user is assigned.", "key": "includeCount", "value": "false" }, { - "description": "If set to true, the API response will include the user profile", + "description": "If set to true, the API response includes the User Profile.", "key": "includeUserProfileType", "value": "false" }, @@ -116560,12 +119972,22 @@ "value": "false" }, { - "description": "If set to true,the response includes skill information for each dynamic skill assignment", + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", "key": "includeSkillDetails", "value": "false" + }, + { + "description": "If set to true, checks if user has the specified dynamic skill", + "key": "checkIfUserHasDynamicSkill", + "value": "false" + }, + { + "description": "Dynamic skill ID to check if user has it assigned (required when checkIfUserHasDynamicSkill is true)", + "key": "dynamicSkillId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false", + "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false&checkIfUserHasDynamicSkill=false&dynamicSkillId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -116613,12 +120035,12 @@ ], "query": [ { - "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", + "description": "If set to true, the API response will include the count of each type of Contact Service Queue to which the user is assigned.", "key": "includeCount", "value": "false" }, { - "description": "If set to true, the API response will include the user profile", + "description": "If set to true, the API response includes the User Profile.", "key": "includeUserProfileType", "value": "false" }, @@ -116633,12 +120055,22 @@ "value": "false" }, { - "description": "If set to true,the response includes skill information for each dynamic skill assignment", + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", "key": "includeSkillDetails", "value": "false" + }, + { + "description": "If set to true, checks if user has the specified dynamic skill", + "key": "checkIfUserHasDynamicSkill", + "value": "false" + }, + { + "description": "Dynamic skill ID to check if user has it assigned (required when checkIfUserHasDynamicSkill is true)", + "key": "dynamicSkillId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false", + "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false&checkIfUserHasDynamicSkill=false&dynamicSkillId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -116685,12 +120117,12 @@ ], "query": [ { - "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", + "description": "If set to true, the API response will include the count of each type of Contact Service Queue to which the user is assigned.", "key": "includeCount", "value": "false" }, { - "description": "If set to true, the API response will include the user profile", + "description": "If set to true, the API response includes the User Profile.", "key": "includeUserProfileType", "value": "false" }, @@ -116705,12 +120137,22 @@ "value": "false" }, { - "description": "If set to true,the response includes skill information for each dynamic skill assignment", + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", "key": "includeSkillDetails", "value": "false" + }, + { + "description": "If set to true, checks if user has the specified dynamic skill", + "key": "checkIfUserHasDynamicSkill", + "value": "false" + }, + { + "description": "Dynamic skill ID to check if user has it assigned (required when checkIfUserHasDynamicSkill is true)", + "key": "dynamicSkillId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false", + "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false&checkIfUserHasDynamicSkill=false&dynamicSkillId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -116757,12 +120199,12 @@ ], "query": [ { - "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", + "description": "If set to true, the API response will include the count of each type of Contact Service Queue to which the user is assigned.", "key": "includeCount", "value": "false" }, { - "description": "If set to true, the API response will include the user profile", + "description": "If set to true, the API response includes the User Profile.", "key": "includeUserProfileType", "value": "false" }, @@ -116777,12 +120219,22 @@ "value": "false" }, { - "description": "If set to true,the response includes skill information for each dynamic skill assignment", + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", "key": "includeSkillDetails", "value": "false" + }, + { + "description": "If set to true, checks if user has the specified dynamic skill", + "key": "checkIfUserHasDynamicSkill", + "value": "false" + }, + { + "description": "Dynamic skill ID to check if user has it assigned (required when checkIfUserHasDynamicSkill is true)", + "key": "dynamicSkillId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false", + "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false&checkIfUserHasDynamicSkill=false&dynamicSkillId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -116829,12 +120281,12 @@ ], "query": [ { - "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", + "description": "If set to true, the API response will include the count of each type of Contact Service Queue to which the user is assigned.", "key": "includeCount", "value": "false" }, { - "description": "If set to true, the API response will include the user profile", + "description": "If set to true, the API response includes the User Profile.", "key": "includeUserProfileType", "value": "false" }, @@ -116849,12 +120301,22 @@ "value": "false" }, { - "description": "If set to true,the response includes skill information for each dynamic skill assignment", + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", "key": "includeSkillDetails", "value": "false" + }, + { + "description": "If set to true, checks if user has the specified dynamic skill", + "key": "checkIfUserHasDynamicSkill", + "value": "false" + }, + { + "description": "Dynamic skill ID to check if user has it assigned (required when checkIfUserHasDynamicSkill is true)", + "key": "dynamicSkillId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false", + "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false&checkIfUserHasDynamicSkill=false&dynamicSkillId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -116901,12 +120363,12 @@ ], "query": [ { - "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", + "description": "If set to true, the API response will include the count of each type of Contact Service Queue to which the user is assigned.", "key": "includeCount", "value": "false" }, { - "description": "If set to true, the API response will include the user profile", + "description": "If set to true, the API response includes the User Profile.", "key": "includeUserProfileType", "value": "false" }, @@ -116921,12 +120383,22 @@ "value": "false" }, { - "description": "If set to true,the response includes skill information for each dynamic skill assignment", + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", "key": "includeSkillDetails", "value": "false" + }, + { + "description": "If set to true, checks if user has the specified dynamic skill", + "key": "checkIfUserHasDynamicSkill", + "value": "false" + }, + { + "description": "Dynamic skill ID to check if user has it assigned (required when checkIfUserHasDynamicSkill is true)", + "key": "dynamicSkillId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false", + "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false&checkIfUserHasDynamicSkill=false&dynamicSkillId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -116943,7 +120415,7 @@ }, { "_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 \"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}", + "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 \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\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": [ @@ -116973,12 +120445,12 @@ ], "query": [ { - "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", + "description": "If set to true, the API response will include the count of each type of Contact Service Queue to which the user is assigned.", "key": "includeCount", "value": "false" }, { - "description": "If set to true, the API response will include the user profile", + "description": "If set to true, the API response includes the User Profile.", "key": "includeUserProfileType", "value": "false" }, @@ -116993,12 +120465,22 @@ "value": "false" }, { - "description": "If set to true,the response includes skill information for each dynamic skill assignment", + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", "key": "includeSkillDetails", "value": "false" + }, + { + "description": "If set to true, checks if user has the specified dynamic skill", + "key": "checkIfUserHasDynamicSkill", + "value": "false" + }, + { + "description": "Dynamic skill ID to check if user has it assigned (required when checkIfUserHasDynamicSkill is true)", + "key": "dynamicSkillId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false", + "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false&checkIfUserHasDynamicSkill=false&dynamicSkillId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -117026,7 +120508,7 @@ "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}" + "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 \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\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": [ @@ -117068,7 +120550,7 @@ "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 \"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}", + "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 \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\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": [ @@ -117087,7 +120569,7 @@ "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}" + "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 \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\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": [ { @@ -117146,7 +120628,7 @@ "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}" + "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 \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\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": [ { @@ -117205,7 +120687,7 @@ "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}" + "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 \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\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": [ { @@ -117264,7 +120746,7 @@ "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}" + "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 \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\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": [ { @@ -117323,7 +120805,7 @@ "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}" + "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 \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\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": [ { @@ -117382,7 +120864,7 @@ "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}" + "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 \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\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": [ { @@ -117441,7 +120923,7 @@ "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}" + "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 \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\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": [ { @@ -117500,7 +120982,7 @@ "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}" + "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 \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\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": [ { @@ -117711,7 +121193,7 @@ }, { "_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 \"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}", + "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 \"supervisorCapabilitiesEnabled\": \"\",\n \"agentCapabilitiesEnabled\": \"\",\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": [ @@ -118442,9 +121924,9 @@ ] }, { - "name": "List User(s)", + "name": "List Users", "request": { - "description": "Retrieve a list of User(s) in a given organization.", + "description": "Retrieve a list of Users in a given organization. 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", @@ -118494,7 +121976,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" }, @@ -118509,12 +121991,12 @@ "value": "" }, { - "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", + "description": "Contact Service Queue ID for which the list of assigned or unassigned agents must 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.", + "description": "If set to true, the API response will include the count of each AI feature mapped to the entity.", "key": "includeAIMappingCount", "value": "false" }, @@ -118597,7 +122079,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" }, @@ -118612,12 +122094,12 @@ "value": "" }, { - "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", + "description": "Contact Service Queue ID for which the list of assigned or unassigned agents must 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.", + "description": "If set to true, the API response will include the count of each AI feature mapped to the entity.", "key": "includeAIMappingCount", "value": "false" }, @@ -118700,7 +122182,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" }, @@ -118715,12 +122197,12 @@ "value": "" }, { - "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", + "description": "Contact Service Queue ID for which the list of assigned or unassigned agents must 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.", + "description": "If set to true, the API response will include the count of each AI feature mapped to the entity.", "key": "includeAIMappingCount", "value": "false" }, @@ -118803,7 +122285,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" }, @@ -118818,12 +122300,12 @@ "value": "" }, { - "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", + "description": "Contact Service Queue ID for which the list of assigned or unassigned agents must 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.", + "description": "If set to true, the API response will include the count of each AI feature mapped to the entity.", "key": "includeAIMappingCount", "value": "false" }, @@ -118906,7 +122388,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" }, @@ -118921,12 +122403,12 @@ "value": "" }, { - "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", + "description": "Contact Service Queue ID for which the list of assigned or unassigned agents must 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.", + "description": "If set to true, the API response will include the count of each AI feature mapped to the entity.", "key": "includeAIMappingCount", "value": "false" }, @@ -119009,7 +122491,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" }, @@ -119024,12 +122506,12 @@ "value": "" }, { - "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", + "description": "Contact Service Queue ID for which the list of assigned or unassigned agents must 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.", + "description": "If set to true, the API response will include the count of each AI feature mapped to the entity.", "key": "includeAIMappingCount", "value": "false" }, @@ -119112,7 +122594,7 @@ "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.", + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", "key": "singleObjectResponse", "value": "false" }, @@ -119127,12 +122609,12 @@ "value": "" }, { - "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", + "description": "Contact Service Queue ID for which the list of assigned or unassigned agents must 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.", + "description": "If set to true, the API response will include the count of each AI feature mapped to the entity.", "key": "includeAIMappingCount", "value": "false" }, @@ -119188,9 +122670,14 @@ "description": "Specifiy whether to include resource collection names", "key": "includeNames", "value": "" + }, + { + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -119248,9 +122735,14 @@ "description": "Specifiy whether to include resource collection names", "key": "includeNames", "value": "" + }, + { + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -119307,9 +122799,14 @@ "description": "Specifiy whether to include resource collection names", "key": "includeNames", "value": "" + }, + { + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -119366,9 +122863,14 @@ "description": "Specifiy whether to include resource collection names", "key": "includeNames", "value": "" + }, + { + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -119385,7 +122887,7 @@ }, { "_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 \"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}", + "body": "", "code": 200, "cookie": [], "header": [ @@ -119425,9 +122927,14 @@ "description": "Specifiy whether to include resource collection names", "key": "includeNames", "value": "" + }, + { + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -119484,9 +122991,14 @@ "description": "Specifiy whether to include resource collection names", "key": "includeNames", "value": "" + }, + { + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -119543,9 +123055,14 @@ "description": "Specifiy whether to include resource collection names", "key": "includeNames", "value": "" + }, + { + "description": "If set to true, the response includes skill information for each dynamic skill assignment.", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -119563,7 +123080,7 @@ ] }, { - "name": "Bulk update User dynamic skills", + "name": "Bulk partial update Users with dynamic skills", "request": { "body": { "mode": "raw", @@ -119607,7 +123124,7 @@ "value": "" }, { - "description": "The unique identifier of the skill.", + "description": "Dynamic skill ID used for bulk update", "key": "skillId", "value": "" } @@ -119669,7 +123186,7 @@ "value": "" }, { - "description": "The unique identifier of the skill.", + "description": "Dynamic skill ID used for bulk update", "key": "skillId", "value": "" } @@ -119732,7 +123249,7 @@ "value": "" }, { - "description": "The unique identifier of the skill.", + "description": "Dynamic skill ID used for bulk update", "key": "skillId", "value": "" } @@ -119795,7 +123312,7 @@ "value": "" }, { - "description": "The unique identifier of the skill.", + "description": "Dynamic skill ID used for bulk update", "key": "skillId", "value": "" } @@ -119858,7 +123375,7 @@ "value": "" }, { - "description": "The unique identifier of the skill.", + "description": "Dynamic skill ID used for bulk update", "key": "skillId", "value": "" } @@ -119921,7 +123438,7 @@ "value": "" }, { - "description": "The unique identifier of the skill.", + "description": "Dynamic skill ID used for bulk update", "key": "skillId", "value": "" } @@ -119984,7 +123501,7 @@ "value": "" }, { - "description": "The unique identifier of the skill.", + "description": "Dynamic skill ID used for bulk update", "key": "skillId", "value": "" } @@ -120047,7 +123564,7 @@ "value": "" }, { - "description": "The unique identifier of the skill.", + "description": "Dynamic skill ID used for bulk update", "key": "skillId", "value": "" } @@ -120440,7 +123957,7 @@ }, { "_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}", + "body": "{\n \"meta\": {\n \"key_0\": 1425\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": [ @@ -120983,37 +124500,18 @@ "status": "Too Many Requests" } ] - } - ], - "name": "Users" - }, - { - "item": [ + }, { - "name": "Create a new Work Type", + "name": "List users by call monitoring 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": "Create a new Work Type in a given organization.", + "description": "Fetch paginated users associated to the selected call monitoring team filters while enforcing team ACL.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -121021,14 +124519,33 @@ "path": [ "organization", ":orgid", - "work-type" + "user", + "by-call-monitoring-id", + ":id" ], - "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": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/by-call-monitoring-id/:id?page=0&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 call monitoring.", + "key": "id", + "value": "" } ] } @@ -121037,7 +124554,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": [ { @@ -121045,29 +124562,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 \"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}}" @@ -121075,23 +124578,43 @@ "path": [ "organization", ":orgid", - "work-type" + "user", + "by-call-monitoring-id", + ":id" ], - "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": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/by-call-monitoring-id/:id?page=0&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": "" + }, + { + "description": "Resource ID of the call monitoring.", + "key": "id", + "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, + "code": 403, "cookie": [], "header": [ { @@ -121099,29 +124622,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 \"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}}" @@ -121129,23 +124638,43 @@ "path": [ "organization", ":orgid", - "work-type" + "user", + "by-call-monitoring-id", + ":id" ], - "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": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/by-call-monitoring-id/:id?page=0&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": "" + }, + { + "description": "Resource ID of the call monitoring.", + "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": 429, + "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 \"actualBurnoutInclusionCount\": \"\",\n \"actualAutoCSATCount\": \"\",\n \"actualSummariesCount\": \"\"\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": [ { @@ -121153,29 +124682,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 \"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}}" @@ -121183,23 +124698,43 @@ "path": [ "organization", ":orgid", - "work-type" + "user", + "by-call-monitoring-id", + ":id" ], - "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": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/by-call-monitoring-id/:id?page=0&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": "" + }, + { + "description": "Resource ID of the call monitoring.", + "key": "id", + "value": "" } ] } }, - "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": 400, + "code": 401, "cookie": [], "header": [ { @@ -121207,29 +124742,15 @@ "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 \"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}}" @@ -121237,23 +124758,43 @@ "path": [ "organization", ":orgid", - "work-type" + "user", + "by-call-monitoring-id", + ":id" ], - "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": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/by-call-monitoring-id/:id?page=0&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": "" + }, + { + "description": "Resource ID of the call monitoring.", + "key": "id", + "value": "" } ] } }, - "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": 404, "cookie": [], "header": [ { @@ -121261,29 +124802,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}}" @@ -121291,23 +124818,43 @@ "path": [ "organization", ":orgid", - "work-type" + "user", + "by-call-monitoring-id", + ":id" ], - "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": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/by-call-monitoring-id/:id?page=0&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": "" + }, + { + "description": "Resource ID of the call monitoring.", + "key": "id", + "value": "" } ] } }, - "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": 429, "cookie": [], "header": [ { @@ -121315,29 +124862,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 \"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}}" @@ -121345,23 +124878,95 @@ "path": [ "organization", ":orgid", - "work-type" + "user", + "by-call-monitoring-id", + ":id" ], - "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": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/by-call-monitoring-id/:id?page=0&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": "" + }, + { + "description": "Resource ID of the call monitoring.", + "key": "id", + "value": "" } ] } }, - "status": "OK" + "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": 403, + "code": 409, "cookie": [], "header": [ { @@ -121369,7 +124974,331 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "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", @@ -122444,7 +126373,7 @@ }, { "_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}", + "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": [ @@ -124466,7 +128395,7 @@ }, { "_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}", + "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}", "code": 200, "cookie": [], "header": [ @@ -124688,7 +128617,7 @@ }, "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.", + "description": "Register a data source with the Webex BYODS system. Authenticate using a Service App with the `spark-admin:datasource_write` scope.\nSchema IDs determine the types of data Webex sends to the DAP and the expected responses. Use the Data Source Schemas endpoints to inspect the available schemas.", "header": [ { "key": "Content-Type", @@ -125317,7 +129246,7 @@ { "name": "Retrieve All Data Sources", "request": { - "description": "Show all data sources registered for this Service App with the scope `spark-admin:datasource_read`.", + "description": "Lists all data sources registered by the Service App. Requires the `spark-admin:datasource_read` scope.", "header": [ { "key": "Accept", @@ -125703,7 +129632,7 @@ { "name": "Retrieve Data Source Schemas", "request": { - "description": "Show available schemas. No specific scope is needed to retrieve the dataSource schemas, but a valid API token should be presented.", + "description": "Lists the available data source schemas. A valid API access token is required, but no specific scope is needed.", "header": [ { "key": "Accept", @@ -126106,7 +130035,7 @@ { "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.", + "description": "Retrieves details for a specific data source schema by schema ID. A valid API access token is required, but no specific scope is needed.", "header": [ { "key": "Accept", @@ -126629,7 +130558,7 @@ { "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.", + "description": "Deletes a data source by ID.\n\nSpecify the data source ID in the `dataSourceId` URI parameter.", "header": [], "method": "DELETE", "url": { @@ -126643,7 +130572,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId", "value": "" } @@ -126672,7 +130601,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -126701,7 +130630,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -126730,7 +130659,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -126759,7 +130688,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -126788,7 +130717,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -126817,7 +130746,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -126846,7 +130775,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -126875,7 +130804,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -126904,7 +130833,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -126933,7 +130862,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -126962,7 +130891,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -126991,7 +130920,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127020,7 +130949,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127049,7 +130978,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127078,7 +131007,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127107,7 +131036,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127120,7 +131049,7 @@ { "name": "Retrieve Data Source Details", "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": "Retrieves details for a data source by ID. Use a Service App token with the `spark-admin:datasource_read` scope.", "header": [ { "key": "Accept", @@ -127139,7 +131068,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId", "value": "" } @@ -127168,7 +131097,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127197,7 +131126,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127226,7 +131155,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127255,7 +131184,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127284,7 +131213,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127313,7 +131242,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127342,7 +131271,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127371,7 +131300,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127400,7 +131329,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127429,7 +131358,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127458,7 +131387,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127487,7 +131416,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127516,7 +131445,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127545,7 +131474,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127584,7 +131513,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127613,7 +131542,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -127636,7 +131565,7 @@ }, "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.", + "description": "Updates a data source. The fields you can update are `audience`, `subject`, `nonce`, `url`, and `tokenLifetimeMinutes`.\nYou can set `status` from `active` to `disabled` only if you provide an `errorMessage`, which may be shown to the customer administrator in Control Hub.\nUpdate tokens before they expire to prevent service interruption.", "header": [ { "key": "Content-Type", @@ -128787,7 +132716,7 @@ }, "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", + "description": "Access this endpoint when the user has to register for a WebSocket Session. Requires one of the following accepted registration scopes: `cjp:user` or `cloud-contact-center:pod_conv`. The `cjp-hybrid-conn:read` scope is also accepted when CCE authentication is enabled. Tokens with only admin or partner roles and no accepted registration scope are rejected.", "header": [ { "key": "Content-Type", @@ -129434,7 +133363,7 @@ }, "raw": "{\n \"isKeepAliveEnabled\": true,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\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": "Access this endpoint when the user has to register for a WebSocket Session to receive realtime events. Requires one of the following accepted registration scopes: `cjp:user` or `cloud-contact-center:pod_conv`. The `cjp-hybrid-conn:read` scope is also accepted when CCE authentication is enabled. Tokens with only admin or partner roles and no accepted registration scope are rejected.", "header": [ { "key": "Content-Type", @@ -138633,6 +142562,195 @@ "status": "Precondition Failed" } ] + }, + { + "name": "Whisper Coach Request", + "request": { + "description": "This feature is currently in Beta. Contact your Cisco team if you want access to this feature.\n\nCreate a Whisper Coach request for the supervisor to coach the agent on a 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", + ":interactionId", + "coach" + ], + "raw": "{{baseUrl}}/v1/monitor/:interactionId/coach", + "variable": [ + { + "description": "The unique ID representing the monitored interaction that the supervisor needs to coach.", + "key": "interactionId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden Request - feature unavailable, non-supervisor, or insufficient Whisper Coach permissions", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "monitor", + ":interactionId", + "coach" + ], + "raw": "{{baseUrl}}/v1/monitor/:interactionId/coach", + "variable": [ + { + "description": "The unique ID representing the monitored interaction that the supervisor needs to coach.", + "key": "interactionId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 202, + "cookie": [], + "header": [], + "name": "The Whisper Coach request was accepted for processing", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "monitor", + ":interactionId", + "coach" + ], + "raw": "{{baseUrl}}/v1/monitor/:interactionId/coach", + "variable": [ + { + "description": "The unique ID representing the monitored interaction that the supervisor needs to coach.", + "key": "interactionId", + "value": "" + } + ] + } + }, + "status": "Accepted" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "monitor", + ":interactionId", + "coach" + ], + "raw": "{{baseUrl}}/v1/monitor/:interactionId/coach", + "variable": [ + { + "description": "The unique ID representing the monitored interaction that the supervisor needs to coach.", + "key": "interactionId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "monitor", + ":interactionId", + "coach" + ], + "raw": "{{baseUrl}}/v1/monitor/:interactionId/coach", + "variable": [ + { + "description": "The unique ID representing the monitored interaction that the supervisor needs to coach.", + "key": "interactionId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized, Token is Invalid", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "monitor", + ":interactionId", + "coach" + ], + "raw": "{{baseUrl}}/v1/monitor/:interactionId/coach", + "variable": [ + { + "description": "The unique ID representing the monitored interaction that the supervisor needs to coach.", + "key": "interactionId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + } + ] } ], "name": "Call Monitoring" @@ -140689,7 +144807,7 @@ ] }, { - "name": "Resume Task", + "name": "Unhold Task", "request": { "body": { "mode": "raw", @@ -144868,9 +148986,9 @@ "language": "json" } }, - "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}" + "raw": "{\n \"origin\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"destination\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"channelType\": \"workItem\",\n \"channelParams\": {\n \"type\": \"work-item-form\",\n \"entryPointId\": \"\",\n \"outboundType\": \"RECORD_GREETING\",\n \"callback\": {\n \"type\": \"immediate\",\n \"origin\": \"web\",\n \"number\": \"\"\n },\n \"sipHeaders\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n \"channel\": \"\",\n \"flowSettings\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"globalVariables\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" }, - "description": "Creates a Work Item task. Requires `CJP_User` scope for authorization.", + "description": "This feature is currently in Beta. Contact your Cisco team if you want access to this feature.\n\nCreates a new contact center task using the v2 task contract. The request body must include a `channelType` discriminator to select the task variant \u2014 `workItem` for structured form tasks, `customMessaging` for conversational messaging tasks, or `telephony` for voice tasks.\n\nOn success, returns a `201` response containing the task ID, which can be used to track the task lifecycle.\n\nRequires `cjp:task_write` OAuth scope. For partner-initiated inbound tasks (`workItem`, `customMessaging`), the `cjp:task_write` scope must be present in the partner application's access token. When an authenticated agent initiates an outdial (`telephony`) task, ensure the `cjp:task_write` scope is included in the agent's access token.", "header": [ { "key": "Content-Type", @@ -144910,7 +149028,7 @@ "language": "json" } }, - "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}" + "raw": "{\n \"origin\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"destination\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"channelType\": \"workItem\",\n \"channelParams\": {\n \"type\": \"work-item-form\",\n \"entryPointId\": \"\",\n \"outboundType\": \"RECORD_GREETING\",\n \"callback\": {\n \"type\": \"immediate\",\n \"origin\": \"web\",\n \"number\": \"\"\n },\n \"sipHeaders\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n \"channel\": \"\",\n \"flowSettings\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"globalVariables\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" }, "header": [ { @@ -144948,7 +149066,7 @@ "language": "json" } }, - "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}" + "raw": "{\n \"origin\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"destination\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"channelType\": \"workItem\",\n \"channelParams\": {\n \"type\": \"work-item-form\",\n \"entryPointId\": \"\",\n \"outboundType\": \"RECORD_GREETING\",\n \"callback\": {\n \"type\": \"immediate\",\n \"origin\": \"web\",\n \"number\": \"\"\n },\n \"sipHeaders\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n \"channel\": \"\",\n \"flowSettings\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"globalVariables\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" }, "header": [ { @@ -144986,7 +149104,7 @@ "language": "json" } }, - "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}" + "raw": "{\n \"origin\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"destination\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"channelType\": \"workItem\",\n \"channelParams\": {\n \"type\": \"work-item-form\",\n \"entryPointId\": \"\",\n \"outboundType\": \"RECORD_GREETING\",\n \"callback\": {\n \"type\": \"immediate\",\n \"origin\": \"web\",\n \"number\": \"\"\n },\n \"sipHeaders\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n \"channel\": \"\",\n \"flowSettings\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"globalVariables\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" }, "header": [ { @@ -145029,7 +149147,7 @@ "language": "json" } }, - "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}" + "raw": "{\n \"origin\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"destination\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"channelType\": \"workItem\",\n \"channelParams\": {\n \"type\": \"work-item-form\",\n \"entryPointId\": \"\",\n \"outboundType\": \"RECORD_GREETING\",\n \"callback\": {\n \"type\": \"immediate\",\n \"origin\": \"web\",\n \"number\": \"\"\n },\n \"sipHeaders\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n \"channel\": \"\",\n \"flowSettings\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"globalVariables\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" }, "header": [ { @@ -145071,7 +149189,7 @@ "language": "json" } }, - "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}" + "raw": "{\n \"origin\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"destination\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"channelType\": \"workItem\",\n \"channelParams\": {\n \"type\": \"work-item-form\",\n \"entryPointId\": \"\",\n \"outboundType\": \"RECORD_GREETING\",\n \"callback\": {\n \"type\": \"immediate\",\n \"origin\": \"web\",\n \"number\": \"\"\n },\n \"sipHeaders\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n \"channel\": \"\",\n \"flowSettings\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"globalVariables\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" }, "header": [ { @@ -145109,7 +149227,7 @@ "language": "json" } }, - "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}" + "raw": "{\n \"origin\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"destination\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"channelType\": \"workItem\",\n \"channelParams\": {\n \"type\": \"work-item-form\",\n \"entryPointId\": \"\",\n \"outboundType\": \"RECORD_GREETING\",\n \"callback\": {\n \"type\": \"immediate\",\n \"origin\": \"web\",\n \"number\": \"\"\n },\n \"sipHeaders\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n \"channel\": \"\",\n \"flowSettings\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"globalVariables\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" }, "header": [ { @@ -145134,7 +149252,7 @@ ] }, { - "name": "Update Task", + "name": "Append Task Message", "request": { "body": { "mode": "raw", @@ -145144,9 +149262,9 @@ "language": "json" } }, - "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}" + "raw": "{\n \"mediaType\": \"customMessaging\",\n \"channelParams\": {\n \"type\": \"text\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\"\n },\n \"timestamp\": \"\"\n }\n }\n}" }, - "description": "Appends a Work Item message to an existing task. This is an asynchronous operation. Requires `CJP_User` scope for authorization.", + "description": "This feature is currently in Beta. Contact your Cisco team if you want access to this feature.\n\nAppends an inbound message to an existing `workItem` or `customMessaging` task. Use this API after the initial task has been created through Create Task. Requires `cjp:task_write` OAuth scope. For partner-initiated inbound message appends, the `cjp:task_write` scope must be present in the partner application's access token.\n\nOn success, returns a `202` response containing the append event identifier as `data.id`. Partners can use this identifier to correlate subsequent webhook delivery for the appended message.", "header": [ { "key": "Content-Type", @@ -145171,7 +149289,7 @@ "raw": "{{baseUrl}}/v2/tasks/:taskId/messages", "variable": [ { - "description": "The unique ID of the Work Item task.", + "description": "UUID of the existing task to which the message will be appended.", "key": "taskId", "value": "" } @@ -145182,10 +149300,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 403, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Forbidden Request", "originalRequest": { "body": { "mode": "raw", @@ -145195,7 +149313,7 @@ "language": "json" } }, - "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}" + "raw": "{\n \"mediaType\": \"customMessaging\",\n \"channelParams\": {\n \"type\": \"text\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\"\n },\n \"timestamp\": \"\"\n }\n }\n}" }, "header": [ { @@ -145217,22 +149335,22 @@ "raw": "{{baseUrl}}/v2/tasks/:taskId/messages", "variable": [ { - "description": "The unique ID of the Work Item task.", + "description": "UUID of the existing task to which the message will be appended.", "key": "taskId", "value": "" } ] } }, - "status": "Service Unavailable" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 400, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", @@ -145242,7 +149360,7 @@ "language": "json" } }, - "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}" + "raw": "{\n \"mediaType\": \"customMessaging\",\n \"channelParams\": {\n \"type\": \"text\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\"\n },\n \"timestamp\": \"\"\n }\n }\n}" }, "header": [ { @@ -145264,22 +149382,78 @@ "raw": "{{baseUrl}}/v2/tasks/:taskId/messages", "variable": [ { - "description": "The unique ID of the Work Item task.", + "description": "UUID of the existing task to which the message will be appended.", "key": "taskId", "value": "" } ] } }, - "status": "Forbidden" + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"orgId\": \"\"\n },\n \"data\": {\n \"id\": \"\"\n }\n}", + "code": 202, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Accepted. The response returns the append event identifier in `data.id`.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"mediaType\": \"customMessaging\",\n \"channelParams\": {\n \"type\": \"text\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\"\n },\n \"timestamp\": \"\"\n }\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "tasks", + ":taskId", + "messages" + ], + "raw": "{{baseUrl}}/v2/tasks/:taskId/messages", + "variable": [ + { + "description": "UUID of the existing task to which the message will be appended.", + "key": "taskId", + "value": "" + } + ] + } + }, + "status": "Accepted" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 500, "cookie": [], "header": [], - "name": "Bad Request", + "name": "Internal Server Error", "originalRequest": { "body": { "mode": "raw", @@ -145289,7 +149463,7 @@ "language": "json" } }, - "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}" + "raw": "{\n \"mediaType\": \"customMessaging\",\n \"channelParams\": {\n \"type\": \"text\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\"\n },\n \"timestamp\": \"\"\n }\n }\n}" }, "header": [ { @@ -145311,27 +149485,22 @@ "raw": "{{baseUrl}}/v2/tasks/:taskId/messages", "variable": [ { - "description": "The unique ID of the Work Item task.", + "description": "UUID of the existing task to which the message will be appended.", "key": "taskId", "value": "" } ] } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{}", - "code": 202, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "The request is accepted for processing", + "header": [], + "name": "Unauthorized, Token is Invalid", "originalRequest": { "body": { "mode": "raw", @@ -145341,16 +149510,12 @@ "language": "json" } }, - "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}" + "raw": "{\n \"mediaType\": \"customMessaging\",\n \"channelParams\": {\n \"type\": \"text\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\"\n },\n \"timestamp\": \"\"\n }\n }\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], "method": "POST", @@ -145367,22 +149532,22 @@ "raw": "{{baseUrl}}/v2/tasks/:taskId/messages", "variable": [ { - "description": "The unique ID of the Work Item task.", + "description": "UUID of the existing task to which the message will be appended.", "key": "taskId", "value": "" } ] } }, - "status": "Accepted" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", + "_postman_previewlanguage": "Text", "body": null, - "code": 500, + "code": 429, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Too Many Requests", "originalRequest": { "body": { "mode": "raw", @@ -145392,7 +149557,7 @@ "language": "json" } }, - "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}" + "raw": "{\n \"mediaType\": \"customMessaging\",\n \"channelParams\": {\n \"type\": \"text\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\"\n },\n \"timestamp\": \"\"\n }\n }\n}" }, "header": [ { @@ -145414,14 +149579,91 @@ "raw": "{{baseUrl}}/v2/tasks/:taskId/messages", "variable": [ { - "description": "The unique ID of the Work Item task.", + "description": "UUID of the existing task to which the message will be appended.", "key": "taskId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "Drop Participant From Conference", + "request": { + "description": "Access this endpoint when the user needs to drop a specific participant from an active conference associated with a task. This operation removes only the targeted participant while keeping the remaining parties in the conference. Requires `cjp:user` scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis)", + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "conference", + "participants", + ":participantId", + "drop" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/participants/:participantId/drop", + "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", + "value": "" + }, + { + "description": "The ID of the participant ( Agent / DN / Entry Point DN / Customer) to be dropped from the conference, maximum length 36 characters.", + "key": "participantId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden Request", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "conference", + "participants", + ":participantId", + "drop" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/participants/:participantId/drop", + "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", + "value": "" + }, + { + "description": "The ID of the participant ( Agent / DN / Entry Point DN / Customer) to be dropped from the conference, maximum length 36 characters.", + "key": "participantId", "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -145431,37 +149673,315 @@ "header": [], "name": "Unauthorized, Token is Invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "conference", + "participants", + ":participantId", + "drop" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/participants/:participantId/drop", + "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", + "value": "" + }, + { + "description": "The ID of the participant ( Agent / DN / Entry Point DN / Customer) to be dropped from the conference, maximum length 36 characters.", + "key": "participantId", + "value": "" } - }, - "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" - } - ], + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too many requests", + "originalRequest": { + "header": [], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", + "v1", "tasks", ":taskId", - "messages" + "conference", + "participants", + ":participantId", + "drop" ], - "raw": "{{baseUrl}}/v2/tasks/:taskId/messages", + "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/participants/:participantId/drop", + "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", + "value": "" + }, + { + "description": "The ID of the participant ( Agent / DN / Entry Point DN / Customer) to be dropped from the conference, maximum length 36 characters.", + "key": "participantId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "conference", + "participants", + ":participantId", + "drop" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/participants/:participantId/drop", + "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", + "value": "" + }, + { + "description": "The ID of the participant ( Agent / DN / Entry Point DN / Customer) to be dropped from the conference, maximum length 36 characters.", + "key": "participantId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 202, + "cookie": [], + "header": [], + "name": "The request is accepted for processing", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "conference", + "participants", + ":participantId", + "drop" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/participants/:participantId/drop", "variable": [ { - "description": "The unique ID of the Work Item 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": "" + }, + { + "description": "The ID of the participant ( Agent / DN / Entry Point DN / Customer) to be dropped from the conference, maximum length 36 characters.", + "key": "participantId", + "value": "" + } + ] + } + }, + "status": "Accepted" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "conference", + "participants", + ":participantId", + "drop" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/participants/:participantId/drop", + "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", + "value": "" + }, + { + "description": "The ID of the participant ( Agent / DN / Entry Point DN / Customer) to be dropped from the conference, maximum length 36 characters.", + "key": "participantId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + } + ] + }, + { + "name": "Pause Task", + "request": { + "description": "Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to pause a task that cannot be handled immediately. This API is supported only for non-real-time digital channels, such as email, social, etc. 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", + "pause" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/pause", + "variable": [ + { + "description": "The unique ID represents the interaction or task that the user wants to pause.", + "key": "taskId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too many requests", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "pause" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/pause", + "variable": [ + { + "description": "The unique ID represents the interaction or task that the user wants to pause.", + "key": "taskId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden Request", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "pause" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/pause", + "variable": [ + { + "description": "The unique ID represents the interaction or task that the user wants to pause.", + "key": "taskId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "pause" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/pause", + "variable": [ + { + "description": "The unique ID represents the interaction or task that the user wants to pause.", "key": "taskId", "value": "" } @@ -145469,6 +149989,387 @@ } }, "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 202, + "cookie": [], + "header": [], + "name": "The request is accepted for processing", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "pause" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/pause", + "variable": [ + { + "description": "The unique ID represents the interaction or task that the user wants to pause.", + "key": "taskId", + "value": "" + } + ] + } + }, + "status": "Accepted" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "pause" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/pause", + "variable": [ + { + "description": "The unique ID represents the interaction or task that the user wants to pause.", + "key": "taskId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "pause" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/pause", + "variable": [ + { + "description": "The unique ID represents the interaction or task that the user wants to pause.", + "key": "taskId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "pause" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/pause", + "variable": [ + { + "description": "The unique ID represents the interaction or task that the user wants to pause.", + "key": "taskId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + } + ] + }, + { + "name": "Resume Task", + "request": { + "description": "Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to resume a previously paused task. This API is supported only for non-real-time digital channels, such as email, social, etc. 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", + "resume" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/resume", + "variable": [ + { + "description": "The unique ID represents the interaction or task that the user wants to resume.", + "key": "taskId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too many requests", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "resume" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/resume", + "variable": [ + { + "description": "The unique ID represents the interaction or task that the user wants to resume.", + "key": "taskId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 202, + "cookie": [], + "header": [], + "name": "The request is accepted for processing", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "resume" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/resume", + "variable": [ + { + "description": "The unique ID represents the interaction or task that the user wants to resume.", + "key": "taskId", + "value": "" + } + ] + } + }, + "status": "Accepted" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "resume" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/resume", + "variable": [ + { + "description": "The unique ID represents the interaction or task that the user wants to resume.", + "key": "taskId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "resume" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/resume", + "variable": [ + { + "description": "The unique ID represents the interaction or task that the user wants to resume.", + "key": "taskId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "resume" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/resume", + "variable": [ + { + "description": "The unique ID represents the interaction or task that the user wants to resume.", + "key": "taskId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden Request", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "resume" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/resume", + "variable": [ + { + "description": "The unique ID represents the interaction or task that the user wants to resume.", + "key": "taskId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "resume" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/resume", + "variable": [ + { + "description": "The unique ID represents the interaction or task that the user wants to resume.", + "key": "taskId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" } ] } @@ -155727,7 +160628,7 @@ "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 \"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 \"validCampaignTimes\": {\n \"timeZone\": \"\",\n \"weeklySchedule\": {\n \"monday\": [\n {\n \"start\": \"21:50\",\n \"end\": \"10:27\"\n },\n {\n \"start\": \"23:18\",\n \"end\": \"16:41\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"20:39\",\n \"end\": \"10:58\"\n },\n {\n \"start\": \"08:38\",\n \"end\": \"20:59\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"08:04\",\n \"end\": \"21:57\"\n },\n {\n \"start\": \"21:23\",\n \"end\": \"13:08\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"22:49\",\n \"end\": \"23:07\"\n },\n {\n \"start\": \"20:04\",\n \"end\": \"23:46\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"17:07\",\n \"end\": \"19:49\"\n },\n {\n \"start\": \"17:49\",\n \"end\": \"09:44\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"20:26\",\n \"end\": \"23:49\"\n },\n {\n \"start\": \"21:55\",\n \"end\": \"23:11\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"01:50\",\n \"end\": \"20:02\"\n },\n {\n \"start\": \"00:44\",\n \"end\": \"23:04\"\n }\n ]\n },\n \"dateOverrides\": [\n {\n \"date\": \"4101-04-03\",\n \"shiftTimes\": [\n {\n \"start\": \"21:17\",\n \"end\": \"20:47\"\n },\n {\n \"start\": \"18:47\",\n \"end\": \"23:28\"\n }\n ]\n },\n {\n \"date\": \"0608-81-36\",\n \"shiftTimes\": [\n {\n \"start\": \"15:47\",\n \"end\": \"01:18\"\n },\n {\n \"start\": \"23:37\",\n \"end\": \"01:02\"\n }\n ]\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": [ @@ -155760,7 +160661,7 @@ "code": 401, "cookie": [], "header": [], - "name": "Invalid or absent Authorization header", + "name": "Unauthorized, Token is Invalid", "originalRequest": { "body": { "mode": "raw", @@ -155770,7 +160671,7 @@ "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 \"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 \"validCampaignTimes\": {\n \"timeZone\": \"\",\n \"weeklySchedule\": {\n \"monday\": [\n {\n \"start\": \"21:50\",\n \"end\": \"10:27\"\n },\n {\n \"start\": \"23:18\",\n \"end\": \"16:41\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"20:39\",\n \"end\": \"10:58\"\n },\n {\n \"start\": \"08:38\",\n \"end\": \"20:59\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"08:04\",\n \"end\": \"21:57\"\n },\n {\n \"start\": \"21:23\",\n \"end\": \"13:08\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"22:49\",\n \"end\": \"23:07\"\n },\n {\n \"start\": \"20:04\",\n \"end\": \"23:46\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"17:07\",\n \"end\": \"19:49\"\n },\n {\n \"start\": \"17:49\",\n \"end\": \"09:44\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"20:26\",\n \"end\": \"23:49\"\n },\n {\n \"start\": \"21:55\",\n \"end\": \"23:11\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"01:50\",\n \"end\": \"20:02\"\n },\n {\n \"start\": \"00:44\",\n \"end\": \"23:04\"\n }\n ]\n },\n \"dateOverrides\": [\n {\n \"date\": \"4101-04-03\",\n \"shiftTimes\": [\n {\n \"start\": \"21:17\",\n \"end\": \"20:47\"\n },\n {\n \"start\": \"18:47\",\n \"end\": \"23:28\"\n }\n ]\n },\n {\n \"date\": \"0608-81-36\",\n \"shiftTimes\": [\n {\n \"start\": \"15:47\",\n \"end\": \"01:18\"\n },\n {\n \"start\": \"23:37\",\n \"end\": \"01:02\"\n }\n ]\n }\n ]\n }\n}" }, "header": [ { @@ -155799,7 +160700,7 @@ "code": 400, "cookie": [], "header": [], - "name": "Incorrect fields in request", + "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", @@ -155809,7 +160710,7 @@ "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 \"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 \"validCampaignTimes\": {\n \"timeZone\": \"\",\n \"weeklySchedule\": {\n \"monday\": [\n {\n \"start\": \"21:50\",\n \"end\": \"10:27\"\n },\n {\n \"start\": \"23:18\",\n \"end\": \"16:41\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"20:39\",\n \"end\": \"10:58\"\n },\n {\n \"start\": \"08:38\",\n \"end\": \"20:59\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"08:04\",\n \"end\": \"21:57\"\n },\n {\n \"start\": \"21:23\",\n \"end\": \"13:08\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"22:49\",\n \"end\": \"23:07\"\n },\n {\n \"start\": \"20:04\",\n \"end\": \"23:46\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"17:07\",\n \"end\": \"19:49\"\n },\n {\n \"start\": \"17:49\",\n \"end\": \"09:44\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"20:26\",\n \"end\": \"23:49\"\n },\n {\n \"start\": \"21:55\",\n \"end\": \"23:11\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"01:50\",\n \"end\": \"20:02\"\n },\n {\n \"start\": \"00:44\",\n \"end\": \"23:04\"\n }\n ]\n },\n \"dateOverrides\": [\n {\n \"date\": \"4101-04-03\",\n \"shiftTimes\": [\n {\n \"start\": \"21:17\",\n \"end\": \"20:47\"\n },\n {\n \"start\": \"18:47\",\n \"end\": \"23:28\"\n }\n ]\n },\n {\n \"date\": \"0608-81-36\",\n \"shiftTimes\": [\n {\n \"start\": \"15:47\",\n \"end\": \"01:18\"\n },\n {\n \"start\": \"23:37\",\n \"end\": \"01:02\"\n }\n ]\n }\n ]\n }\n}" }, "header": [ { @@ -155838,7 +160739,7 @@ "code": 403, "cookie": [], "header": [], - "name": "Invalid OAuth 2.0 Bearer Token", + "name": "Forbidden Request", "originalRequest": { "body": { "mode": "raw", @@ -155848,7 +160749,7 @@ "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 \"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 \"validCampaignTimes\": {\n \"timeZone\": \"\",\n \"weeklySchedule\": {\n \"monday\": [\n {\n \"start\": \"21:50\",\n \"end\": \"10:27\"\n },\n {\n \"start\": \"23:18\",\n \"end\": \"16:41\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"20:39\",\n \"end\": \"10:58\"\n },\n {\n \"start\": \"08:38\",\n \"end\": \"20:59\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"08:04\",\n \"end\": \"21:57\"\n },\n {\n \"start\": \"21:23\",\n \"end\": \"13:08\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"22:49\",\n \"end\": \"23:07\"\n },\n {\n \"start\": \"20:04\",\n \"end\": \"23:46\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"17:07\",\n \"end\": \"19:49\"\n },\n {\n \"start\": \"17:49\",\n \"end\": \"09:44\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"20:26\",\n \"end\": \"23:49\"\n },\n {\n \"start\": \"21:55\",\n \"end\": \"23:11\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"01:50\",\n \"end\": \"20:02\"\n },\n {\n \"start\": \"00:44\",\n \"end\": \"23:04\"\n }\n ]\n },\n \"dateOverrides\": [\n {\n \"date\": \"4101-04-03\",\n \"shiftTimes\": [\n {\n \"start\": \"21:17\",\n \"end\": \"20:47\"\n },\n {\n \"start\": \"18:47\",\n \"end\": \"23:28\"\n }\n ]\n },\n {\n \"date\": \"0608-81-36\",\n \"shiftTimes\": [\n {\n \"start\": \"15:47\",\n \"end\": \"01:18\"\n },\n {\n \"start\": \"23:37\",\n \"end\": \"01:02\"\n }\n ]\n }\n ]\n }\n}" }, "header": [ { @@ -155892,7 +160793,7 @@ "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 \"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 \"validCampaignTimes\": {\n \"timeZone\": \"\",\n \"weeklySchedule\": {\n \"monday\": [\n {\n \"start\": \"21:50\",\n \"end\": \"10:27\"\n },\n {\n \"start\": \"23:18\",\n \"end\": \"16:41\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"20:39\",\n \"end\": \"10:58\"\n },\n {\n \"start\": \"08:38\",\n \"end\": \"20:59\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"08:04\",\n \"end\": \"21:57\"\n },\n {\n \"start\": \"21:23\",\n \"end\": \"13:08\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"22:49\",\n \"end\": \"23:07\"\n },\n {\n \"start\": \"20:04\",\n \"end\": \"23:46\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"17:07\",\n \"end\": \"19:49\"\n },\n {\n \"start\": \"17:49\",\n \"end\": \"09:44\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"20:26\",\n \"end\": \"23:49\"\n },\n {\n \"start\": \"21:55\",\n \"end\": \"23:11\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"01:50\",\n \"end\": \"20:02\"\n },\n {\n \"start\": \"00:44\",\n \"end\": \"23:04\"\n }\n ]\n },\n \"dateOverrides\": [\n {\n \"date\": \"4101-04-03\",\n \"shiftTimes\": [\n {\n \"start\": \"21:17\",\n \"end\": \"20:47\"\n },\n {\n \"start\": \"18:47\",\n \"end\": \"23:28\"\n }\n ]\n },\n {\n \"date\": \"0608-81-36\",\n \"shiftTimes\": [\n {\n \"start\": \"15:47\",\n \"end\": \"01:18\"\n },\n {\n \"start\": \"23:37\",\n \"end\": \"01:02\"\n }\n ]\n }\n ]\n }\n}" }, "header": [ { @@ -155935,7 +160836,7 @@ "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 \"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 \"validCampaignTimes\": {\n \"timeZone\": \"\",\n \"weeklySchedule\": {\n \"monday\": [\n {\n \"start\": \"21:50\",\n \"end\": \"10:27\"\n },\n {\n \"start\": \"23:18\",\n \"end\": \"16:41\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"20:39\",\n \"end\": \"10:58\"\n },\n {\n \"start\": \"08:38\",\n \"end\": \"20:59\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"08:04\",\n \"end\": \"21:57\"\n },\n {\n \"start\": \"21:23\",\n \"end\": \"13:08\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"22:49\",\n \"end\": \"23:07\"\n },\n {\n \"start\": \"20:04\",\n \"end\": \"23:46\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"17:07\",\n \"end\": \"19:49\"\n },\n {\n \"start\": \"17:49\",\n \"end\": \"09:44\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"20:26\",\n \"end\": \"23:49\"\n },\n {\n \"start\": \"21:55\",\n \"end\": \"23:11\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"01:50\",\n \"end\": \"20:02\"\n },\n {\n \"start\": \"00:44\",\n \"end\": \"23:04\"\n }\n ]\n },\n \"dateOverrides\": [\n {\n \"date\": \"4101-04-03\",\n \"shiftTimes\": [\n {\n \"start\": \"21:17\",\n \"end\": \"20:47\"\n },\n {\n \"start\": \"18:47\",\n \"end\": \"23:28\"\n }\n ]\n },\n {\n \"date\": \"0608-81-36\",\n \"shiftTimes\": [\n {\n \"start\": \"15:47\",\n \"end\": \"01:18\"\n },\n {\n \"start\": \"23:37\",\n \"end\": \"01:02\"\n }\n ]\n }\n ]\n }\n}" }, "header": [ { @@ -155974,7 +160875,7 @@ "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 \"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 \"validCampaignTimes\": {\n \"timeZone\": \"\",\n \"weeklySchedule\": {\n \"monday\": [\n {\n \"start\": \"21:50\",\n \"end\": \"10:27\"\n },\n {\n \"start\": \"23:18\",\n \"end\": \"16:41\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"20:39\",\n \"end\": \"10:58\"\n },\n {\n \"start\": \"08:38\",\n \"end\": \"20:59\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"08:04\",\n \"end\": \"21:57\"\n },\n {\n \"start\": \"21:23\",\n \"end\": \"13:08\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"22:49\",\n \"end\": \"23:07\"\n },\n {\n \"start\": \"20:04\",\n \"end\": \"23:46\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"17:07\",\n \"end\": \"19:49\"\n },\n {\n \"start\": \"17:49\",\n \"end\": \"09:44\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"20:26\",\n \"end\": \"23:49\"\n },\n {\n \"start\": \"21:55\",\n \"end\": \"23:11\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"01:50\",\n \"end\": \"20:02\"\n },\n {\n \"start\": \"00:44\",\n \"end\": \"23:04\"\n }\n ]\n },\n \"dateOverrides\": [\n {\n \"date\": \"4101-04-03\",\n \"shiftTimes\": [\n {\n \"start\": \"21:17\",\n \"end\": \"20:47\"\n },\n {\n \"start\": \"18:47\",\n \"end\": \"23:28\"\n }\n ]\n },\n {\n \"date\": \"0608-81-36\",\n \"shiftTimes\": [\n {\n \"start\": \"15:47\",\n \"end\": \"01:18\"\n },\n {\n \"start\": \"23:37\",\n \"end\": \"01:02\"\n }\n ]\n }\n ]\n }\n}" }, "header": [ { @@ -156010,7 +160911,7 @@ "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 \"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 \"validCampaignTimes\": {\n \"timeZone\": \"\",\n \"weeklySchedule\": {\n \"monday\": [\n {\n \"start\": \"00:07\",\n \"end\": \"13:06\"\n },\n {\n \"start\": \"07:04\",\n \"end\": \"03:00\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"20:00\",\n \"end\": \"22:28\"\n },\n {\n \"start\": \"00:29\",\n \"end\": \"17:06\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"06:55\",\n \"end\": \"17:21\"\n },\n {\n \"start\": \"05:36\",\n \"end\": \"20:37\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"16:22\",\n \"end\": \"23:55\"\n },\n {\n \"start\": \"23:46\",\n \"end\": \"09:01\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"18:50\",\n \"end\": \"22:33\"\n },\n {\n \"start\": \"22:49\",\n \"end\": \"21:54\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"14:31\",\n \"end\": \"20:21\"\n },\n {\n \"start\": \"13:42\",\n \"end\": \"00:08\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"23:30\",\n \"end\": \"23:50\"\n },\n {\n \"start\": \"17:40\",\n \"end\": \"09:21\"\n }\n ]\n },\n \"dateOverrides\": [\n {\n \"date\": \"7797-94-57\",\n \"shiftTimes\": [\n {\n \"start\": \"20:34\",\n \"end\": \"23:52\"\n },\n {\n \"start\": \"10:38\",\n \"end\": \"21:36\"\n }\n ]\n },\n {\n \"date\": \"2274-60-85\",\n \"shiftTimes\": [\n {\n \"start\": \"19:32\",\n \"end\": \"11:57\"\n },\n {\n \"start\": \"22:28\",\n \"end\": \"15:18\"\n }\n ]\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": [ @@ -156051,7 +160952,7 @@ "code": 403, "cookie": [], "header": [], - "name": "Invalid OAuth 2.0 Bearer Token", + "name": "Forbidden Request", "originalRequest": { "body": { "mode": "raw", @@ -156061,7 +160962,7 @@ "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 \"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 \"validCampaignTimes\": {\n \"timeZone\": \"\",\n \"weeklySchedule\": {\n \"monday\": [\n {\n \"start\": \"00:07\",\n \"end\": \"13:06\"\n },\n {\n \"start\": \"07:04\",\n \"end\": \"03:00\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"20:00\",\n \"end\": \"22:28\"\n },\n {\n \"start\": \"00:29\",\n \"end\": \"17:06\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"06:55\",\n \"end\": \"17:21\"\n },\n {\n \"start\": \"05:36\",\n \"end\": \"20:37\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"16:22\",\n \"end\": \"23:55\"\n },\n {\n \"start\": \"23:46\",\n \"end\": \"09:01\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"18:50\",\n \"end\": \"22:33\"\n },\n {\n \"start\": \"22:49\",\n \"end\": \"21:54\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"14:31\",\n \"end\": \"20:21\"\n },\n {\n \"start\": \"13:42\",\n \"end\": \"00:08\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"23:30\",\n \"end\": \"23:50\"\n },\n {\n \"start\": \"17:40\",\n \"end\": \"09:21\"\n }\n ]\n },\n \"dateOverrides\": [\n {\n \"date\": \"7797-94-57\",\n \"shiftTimes\": [\n {\n \"start\": \"20:34\",\n \"end\": \"23:52\"\n },\n {\n \"start\": \"10:38\",\n \"end\": \"21:36\"\n }\n ]\n },\n {\n \"date\": \"2274-60-85\",\n \"shiftTimes\": [\n {\n \"start\": \"19:32\",\n \"end\": \"11:57\"\n },\n {\n \"start\": \"22:28\",\n \"end\": \"15:18\"\n }\n ]\n }\n ]\n }\n}" }, "header": [ { @@ -156097,7 +160998,7 @@ "code": 400, "cookie": [], "header": [], - "name": "Incorrect fields in request", + "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", @@ -156107,7 +161008,7 @@ "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 \"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 \"validCampaignTimes\": {\n \"timeZone\": \"\",\n \"weeklySchedule\": {\n \"monday\": [\n {\n \"start\": \"00:07\",\n \"end\": \"13:06\"\n },\n {\n \"start\": \"07:04\",\n \"end\": \"03:00\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"20:00\",\n \"end\": \"22:28\"\n },\n {\n \"start\": \"00:29\",\n \"end\": \"17:06\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"06:55\",\n \"end\": \"17:21\"\n },\n {\n \"start\": \"05:36\",\n \"end\": \"20:37\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"16:22\",\n \"end\": \"23:55\"\n },\n {\n \"start\": \"23:46\",\n \"end\": \"09:01\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"18:50\",\n \"end\": \"22:33\"\n },\n {\n \"start\": \"22:49\",\n \"end\": \"21:54\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"14:31\",\n \"end\": \"20:21\"\n },\n {\n \"start\": \"13:42\",\n \"end\": \"00:08\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"23:30\",\n \"end\": \"23:50\"\n },\n {\n \"start\": \"17:40\",\n \"end\": \"09:21\"\n }\n ]\n },\n \"dateOverrides\": [\n {\n \"date\": \"7797-94-57\",\n \"shiftTimes\": [\n {\n \"start\": \"20:34\",\n \"end\": \"23:52\"\n },\n {\n \"start\": \"10:38\",\n \"end\": \"21:36\"\n }\n ]\n },\n {\n \"date\": \"2274-60-85\",\n \"shiftTimes\": [\n {\n \"start\": \"19:32\",\n \"end\": \"11:57\"\n },\n {\n \"start\": \"22:28\",\n \"end\": \"15:18\"\n }\n ]\n }\n ]\n }\n}" }, "header": [ { @@ -156153,7 +161054,7 @@ "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 \"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 \"validCampaignTimes\": {\n \"timeZone\": \"\",\n \"weeklySchedule\": {\n \"monday\": [\n {\n \"start\": \"00:07\",\n \"end\": \"13:06\"\n },\n {\n \"start\": \"07:04\",\n \"end\": \"03:00\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"20:00\",\n \"end\": \"22:28\"\n },\n {\n \"start\": \"00:29\",\n \"end\": \"17:06\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"06:55\",\n \"end\": \"17:21\"\n },\n {\n \"start\": \"05:36\",\n \"end\": \"20:37\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"16:22\",\n \"end\": \"23:55\"\n },\n {\n \"start\": \"23:46\",\n \"end\": \"09:01\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"18:50\",\n \"end\": \"22:33\"\n },\n {\n \"start\": \"22:49\",\n \"end\": \"21:54\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"14:31\",\n \"end\": \"20:21\"\n },\n {\n \"start\": \"13:42\",\n \"end\": \"00:08\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"23:30\",\n \"end\": \"23:50\"\n },\n {\n \"start\": \"17:40\",\n \"end\": \"09:21\"\n }\n ]\n },\n \"dateOverrides\": [\n {\n \"date\": \"7797-94-57\",\n \"shiftTimes\": [\n {\n \"start\": \"20:34\",\n \"end\": \"23:52\"\n },\n {\n \"start\": \"10:38\",\n \"end\": \"21:36\"\n }\n ]\n },\n {\n \"date\": \"2274-60-85\",\n \"shiftTimes\": [\n {\n \"start\": \"19:32\",\n \"end\": \"11:57\"\n },\n {\n \"start\": \"22:28\",\n \"end\": \"15:18\"\n }\n ]\n }\n ]\n }\n}" }, "header": [ { @@ -156199,7 +161100,7 @@ "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 \"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 \"validCampaignTimes\": {\n \"timeZone\": \"\",\n \"weeklySchedule\": {\n \"monday\": [\n {\n \"start\": \"00:07\",\n \"end\": \"13:06\"\n },\n {\n \"start\": \"07:04\",\n \"end\": \"03:00\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"20:00\",\n \"end\": \"22:28\"\n },\n {\n \"start\": \"00:29\",\n \"end\": \"17:06\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"06:55\",\n \"end\": \"17:21\"\n },\n {\n \"start\": \"05:36\",\n \"end\": \"20:37\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"16:22\",\n \"end\": \"23:55\"\n },\n {\n \"start\": \"23:46\",\n \"end\": \"09:01\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"18:50\",\n \"end\": \"22:33\"\n },\n {\n \"start\": \"22:49\",\n \"end\": \"21:54\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"14:31\",\n \"end\": \"20:21\"\n },\n {\n \"start\": \"13:42\",\n \"end\": \"00:08\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"23:30\",\n \"end\": \"23:50\"\n },\n {\n \"start\": \"17:40\",\n \"end\": \"09:21\"\n }\n ]\n },\n \"dateOverrides\": [\n {\n \"date\": \"7797-94-57\",\n \"shiftTimes\": [\n {\n \"start\": \"20:34\",\n \"end\": \"23:52\"\n },\n {\n \"start\": \"10:38\",\n \"end\": \"21:36\"\n }\n ]\n },\n {\n \"date\": \"2274-60-85\",\n \"shiftTimes\": [\n {\n \"start\": \"19:32\",\n \"end\": \"11:57\"\n },\n {\n \"start\": \"22:28\",\n \"end\": \"15:18\"\n }\n ]\n }\n ]\n }\n}" }, "header": [ { @@ -156235,7 +161136,7 @@ "code": 401, "cookie": [], "header": [], - "name": "Invalid or absent Authorization header", + "name": "Unauthorized, Token is Invalid", "originalRequest": { "body": { "mode": "raw", @@ -156245,7 +161146,7 @@ "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 \"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 \"validCampaignTimes\": {\n \"timeZone\": \"\",\n \"weeklySchedule\": {\n \"monday\": [\n {\n \"start\": \"00:07\",\n \"end\": \"13:06\"\n },\n {\n \"start\": \"07:04\",\n \"end\": \"03:00\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"20:00\",\n \"end\": \"22:28\"\n },\n {\n \"start\": \"00:29\",\n \"end\": \"17:06\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"06:55\",\n \"end\": \"17:21\"\n },\n {\n \"start\": \"05:36\",\n \"end\": \"20:37\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"16:22\",\n \"end\": \"23:55\"\n },\n {\n \"start\": \"23:46\",\n \"end\": \"09:01\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"18:50\",\n \"end\": \"22:33\"\n },\n {\n \"start\": \"22:49\",\n \"end\": \"21:54\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"14:31\",\n \"end\": \"20:21\"\n },\n {\n \"start\": \"13:42\",\n \"end\": \"00:08\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"23:30\",\n \"end\": \"23:50\"\n },\n {\n \"start\": \"17:40\",\n \"end\": \"09:21\"\n }\n ]\n },\n \"dateOverrides\": [\n {\n \"date\": \"7797-94-57\",\n \"shiftTimes\": [\n {\n \"start\": \"20:34\",\n \"end\": \"23:52\"\n },\n {\n \"start\": \"10:38\",\n \"end\": \"21:36\"\n }\n ]\n },\n {\n \"date\": \"2274-60-85\",\n \"shiftTimes\": [\n {\n \"start\": \"19:32\",\n \"end\": \"11:57\"\n },\n {\n \"start\": \"22:28\",\n \"end\": \"15:18\"\n }\n ]\n }\n ]\n }\n}" }, "header": [ { @@ -156296,7 +161197,7 @@ "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 \"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 \"validCampaignTimes\": {\n \"timeZone\": \"\",\n \"weeklySchedule\": {\n \"monday\": [\n {\n \"start\": \"00:07\",\n \"end\": \"13:06\"\n },\n {\n \"start\": \"07:04\",\n \"end\": \"03:00\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"20:00\",\n \"end\": \"22:28\"\n },\n {\n \"start\": \"00:29\",\n \"end\": \"17:06\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"06:55\",\n \"end\": \"17:21\"\n },\n {\n \"start\": \"05:36\",\n \"end\": \"20:37\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"16:22\",\n \"end\": \"23:55\"\n },\n {\n \"start\": \"23:46\",\n \"end\": \"09:01\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"18:50\",\n \"end\": \"22:33\"\n },\n {\n \"start\": \"22:49\",\n \"end\": \"21:54\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"14:31\",\n \"end\": \"20:21\"\n },\n {\n \"start\": \"13:42\",\n \"end\": \"00:08\"\n }\n ],\n \"sunday\": [\n {\n \"start\": \"23:30\",\n \"end\": \"23:50\"\n },\n {\n \"start\": \"17:40\",\n \"end\": \"09:21\"\n }\n ]\n },\n \"dateOverrides\": [\n {\n \"date\": \"7797-94-57\",\n \"shiftTimes\": [\n {\n \"start\": \"20:34\",\n \"end\": \"23:52\"\n },\n {\n \"start\": \"10:38\",\n \"end\": \"21:36\"\n }\n ]\n },\n {\n \"date\": \"2274-60-85\",\n \"shiftTimes\": [\n {\n \"start\": \"19:32\",\n \"end\": \"11:57\"\n },\n {\n \"start\": \"22:28\",\n \"end\": \"15:18\"\n }\n ]\n }\n ]\n }\n}" }, "header": [ { @@ -156396,7 +161297,7 @@ "code": 403, "cookie": [], "header": [], - "name": "Invalid OAuth 2.0 Bearer Token", + "name": "Forbidden Request", "originalRequest": { "header": [], "method": "DELETE", @@ -156427,7 +161328,7 @@ "code": 401, "cookie": [], "header": [], - "name": "Invalid or absent Authorization header", + "name": "Unauthorized, Token is Invalid", "originalRequest": { "header": [], "method": "DELETE", @@ -156520,7 +161421,7 @@ "code": 400, "cookie": [], "header": [], - "name": "Incorrect fields in request", + "name": "Bad Request", "originalRequest": { "header": [], "method": "DELETE", @@ -156546,6 +161447,381 @@ "status": "Bad Request" } ] + }, + { + "name": "Get Valid Campaign Times", + "request": { + "description": "Gets valid campaign times for a campaign and agent. This request is accepted for asynchronous processing. Requires 'cjp:user','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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "organization", + ":orgId", + "getValidCampaignTimes" + ], + "query": [ + { + "description": "The campaign ID for which valid campaign times are being requested.", + "key": "campaignId", + "value": "" + }, + { + "description": "The unique identifier of the interaction associated with this request.", + "key": "interactionId", + "value": "" + }, + { + "description": "The agent ID for whom valid campaign times are being requested.", + "key": "agentId", + "value": "" + }, + { + "description": "Optional tracking identifier for request tracing.", + "key": "trackingId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/organization/:orgId/getValidCampaignTimes?campaignId=&interactionId=&agentId=&trackingId=", + "variable": [ + { + "description": "The organization ID for which valid campaign times are being requested.", + "key": "orgId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "organization", + ":orgId", + "getValidCampaignTimes" + ], + "query": [ + { + "description": "The campaign ID for which valid campaign times are being requested.", + "key": "campaignId", + "value": "" + }, + { + "description": "The unique identifier of the interaction associated with this request.", + "key": "interactionId", + "value": "" + }, + { + "description": "The agent ID for whom valid campaign times are being requested.", + "key": "agentId", + "value": "" + }, + { + "description": "Optional tracking identifier for request tracing.", + "key": "trackingId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/organization/:orgId/getValidCampaignTimes?campaignId=&interactionId=&agentId=&trackingId=", + "variable": [ + { + "description": "The organization ID for which valid campaign times are being requested.", + "key": "orgId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "organization", + ":orgId", + "getValidCampaignTimes" + ], + "query": [ + { + "description": "The campaign ID for which valid campaign times are being requested.", + "key": "campaignId", + "value": "" + }, + { + "description": "The unique identifier of the interaction associated with this request.", + "key": "interactionId", + "value": "" + }, + { + "description": "The agent ID for whom valid campaign times are being requested.", + "key": "agentId", + "value": "" + }, + { + "description": "Optional tracking identifier for request tracing.", + "key": "trackingId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/organization/:orgId/getValidCampaignTimes?campaignId=&interactionId=&agentId=&trackingId=", + "variable": [ + { + "description": "The organization ID for which valid campaign times are being requested.", + "key": "orgId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized, Token is Invalid", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "organization", + ":orgId", + "getValidCampaignTimes" + ], + "query": [ + { + "description": "The campaign ID for which valid campaign times are being requested.", + "key": "campaignId", + "value": "" + }, + { + "description": "The unique identifier of the interaction associated with this request.", + "key": "interactionId", + "value": "" + }, + { + "description": "The agent ID for whom valid campaign times are being requested.", + "key": "agentId", + "value": "" + }, + { + "description": "Optional tracking identifier for request tracing.", + "key": "trackingId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/organization/:orgId/getValidCampaignTimes?campaignId=&interactionId=&agentId=&trackingId=", + "variable": [ + { + "description": "The organization ID for which valid campaign times are being requested.", + "key": "orgId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 200, + "cookie": [], + "header": [], + "name": "The valid campaign times request was accepted for processing.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "organization", + ":orgId", + "getValidCampaignTimes" + ], + "query": [ + { + "description": "The campaign ID for which valid campaign times are being requested.", + "key": "campaignId", + "value": "" + }, + { + "description": "The unique identifier of the interaction associated with this request.", + "key": "interactionId", + "value": "" + }, + { + "description": "The agent ID for whom valid campaign times are being requested.", + "key": "agentId", + "value": "" + }, + { + "description": "Optional tracking identifier for request tracing.", + "key": "trackingId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/organization/:orgId/getValidCampaignTimes?campaignId=&interactionId=&agentId=&trackingId=", + "variable": [ + { + "description": "The organization ID for which valid campaign times are being requested.", + "key": "orgId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden Request", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "organization", + ":orgId", + "getValidCampaignTimes" + ], + "query": [ + { + "description": "The campaign ID for which valid campaign times are being requested.", + "key": "campaignId", + "value": "" + }, + { + "description": "The unique identifier of the interaction associated with this request.", + "key": "interactionId", + "value": "" + }, + { + "description": "The agent ID for whom valid campaign times are being requested.", + "key": "agentId", + "value": "" + }, + { + "description": "Optional tracking identifier for request tracing.", + "key": "trackingId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/organization/:orgId/getValidCampaignTimes?campaignId=&interactionId=&agentId=&trackingId=", + "variable": [ + { + "description": "The organization ID for which valid campaign times are being requested.", + "key": "orgId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "organization", + ":orgId", + "getValidCampaignTimes" + ], + "query": [ + { + "description": "The campaign ID for which valid campaign times are being requested.", + "key": "campaignId", + "value": "" + }, + { + "description": "The unique identifier of the interaction associated with this request.", + "key": "interactionId", + "value": "" + }, + { + "description": "The agent ID for whom valid campaign times are being requested.", + "key": "agentId", + "value": "" + }, + { + "description": "Optional tracking identifier for request tracing.", + "key": "trackingId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/organization/:orgId/getValidCampaignTimes?campaignId=&interactionId=&agentId=&trackingId=", + "variable": [ + { + "description": "The organization ID for which valid campaign times are being requested.", + "key": "orgId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + } + ] } ], "name": "Campaign Manager" @@ -156563,9 +161839,9 @@ "language": "json" } }, - "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\"\n }\n}" + "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\",\n \"includeScreenRecordings\": \"\",\n \"includeAllDigitalVersions\": \"\"\n }\n}" }, - "description": "Retrieve a list of Captures given a set of task IDs", + "description": "Retrieve a list of Captures given a set of task IDs.\n\n### Captures Availability\n\nNot all tasks will have captures by default and they will be available based on the organization's configurations and retention policy. Querying closed tasks is recommended, as open tasks may return incomplete data.\n\nTranscripts retrieved through this API are post-interaction artifacts.\n- For voice, transcripts are available when at least one transcript based configuration/feature is enabled such as Auto CSAT, Agent Well Being, Call Drop Summary, Topics Analytics.\n\n- For digital channels such as Chat, Email, Social, Work Item, and Custom Messaging, transcripts are generated from the conversation messages. Please refer [guide for digital transcripts](/docs/guide-for-digital-transcripts) for more details\n\n### URL Expiry\n\nThe maximum duration of validity of pre signed URL or default value when no value is passed for urlExpiration is 60 minutes.\n\n### Authentication & Authorization\n\nThis API requires a valid bearer token. The caller must satisfy the scope and role requirements for one of the following:\n\n#### Service App\n- **Required Scope:** `cjp:config_read`\n- The `orgId` must be provided in the request body and must match the token's org.\n- For service app setup, refer to [Contact Center Service Apps](/docs/contact-center-service-apps).\n\n#### Org Admin\n- **Required Scopes:** `Identity:SCIM` and `Identity:Organization`\n- **Required Role (one of):** `id_full_admin`, `id_readonly_admin`, `cjp.admin`, or `atlas-portal.partner.provision_admin`\n- The user must belong to the organization being queried. If `orgId` is provided in the request body, it must match the token's org. If `orgId` is omitted, it is inferred from the token.\n\n#### Partner Admin\n- **Required Scope:** `Identity:SCIM` for the managed org\n- **Required Role:** `atlas-portal.partner.salesadmin`\n- The org ID must be included in the managed org list. This is accomplished by adding the org to the `Managed customer orgs` list in control hub.\n\n#### Supervisor\n- **Required Role:** `cjp.supervisor`\n- The user must belong to the organization being queried. If `orgId` is provided in the request body, it must match the token's org. If `orgId` is omitted, it is inferred from the token.\n\n**Note:** Please refer to the contact center setup documentation for the configuration details.\n\n", "header": [ { "key": "Content-Type", @@ -156611,7 +161887,7 @@ "language": "json" } }, - "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\"\n }\n}" + "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\",\n \"includeScreenRecordings\": \"\",\n \"includeAllDigitalVersions\": \"\"\n }\n}" }, "header": [ { @@ -156654,7 +161930,7 @@ "language": "json" } }, - "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\"\n }\n}" + "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\",\n \"includeScreenRecordings\": \"\",\n \"includeAllDigitalVersions\": \"\"\n }\n}" }, "header": [ { @@ -156693,7 +161969,7 @@ "language": "json" } }, - "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\"\n }\n}" + "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\",\n \"includeScreenRecordings\": \"\",\n \"includeAllDigitalVersions\": \"\"\n }\n}" }, "header": [ { @@ -156732,7 +162008,7 @@ "language": "json" } }, - "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\"\n }\n}" + "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\",\n \"includeScreenRecordings\": \"\",\n \"includeAllDigitalVersions\": \"\"\n }\n}" }, "header": [ { @@ -156771,7 +162047,7 @@ "language": "json" } }, - "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\"\n }\n}" + "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\",\n \"includeScreenRecordings\": \"\",\n \"includeAllDigitalVersions\": \"\"\n }\n}" }, "header": [ { @@ -156810,7 +162086,7 @@ "language": "json" } }, - "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\"\n }\n}" + "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\",\n \"includeScreenRecordings\": \"\",\n \"includeAllDigitalVersions\": \"\"\n }\n}" }, "header": [ { @@ -156849,7 +162125,7 @@ "language": "json" } }, - "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\"\n }\n}" + "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\",\n \"includeScreenRecordings\": \"\",\n \"includeAllDigitalVersions\": \"\"\n }\n}" }, "header": [ { @@ -157466,7 +162742,7 @@ }, { "_postman_previewlanguage": "json", - "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}", + "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 \"key_1\": {\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 \"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 },\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 \"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 \"key_2\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n },\n \"key_3\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n },\n \"key_4\": {\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 \"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 \"key_2\": {\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 \"key_1\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"key_2\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"key_3\": {\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 \"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}", "code": 200, "cookie": [], "header": [ @@ -157725,7 +163001,7 @@ }, { "_postman_previewlanguage": "json", - "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}", + "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 }\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 \"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 \"key_1\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"key_2\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"key_3\": {\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 \"key_2\": [\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n },\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n }\n ],\n \"key_3\": [\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 }\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 },\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 \"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 \"key_3\": {\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 \"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 \"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 },\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": [ @@ -163596,7 +168872,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": 2564.9912264745376,\n \"key_2\": 3558\n },\n \"data\": [\n {\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"F0a166de4A2E-9ebe-6D2B-F0B2d2576391\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"24A4C895-07ac-E1a5-C51f-Ba15cA47e964\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"key_0\": \"string\"\n },\n \"data\": [\n {\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"F0a166de4A2E-9ebe-6D2B-F0B2d2576391\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"24A4C895-07ac-E1a5-C51f-Ba15cA47e964\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -163878,7 +169154,7 @@ }, "raw": "{\n \"agentPersonalGreetingInfo\": {\n \"agentId\": \"\",\n \"contentType\": \"TEXT_PHP\",\n \"name\": \"\u202fZ\u2029\u202fa\u200a. \",\n \"organizationId\": \"D4D8cD07f38E-9dbBf7D0fE64c7F1073f\",\n \"id\": \"\",\n \"version\": \"\",\n \"blobId\": \"\",\n \"url\": \"\",\n \"attributeTag\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"agentActive\": \"\",\n \"ciUserId\": \"\",\n \"audioFile\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"audioFile\": \"\"\n}" }, - "description": "Create a new agent personal greeting File for a given organization.", + "description": "Create a new Greeting File in a given organization.", "header": [ { "key": "Content-Type", @@ -164291,7 +169567,7 @@ ] }, { - "name": "delete References 1", + "name": "Delete references of an agent from greeting files", "request": { "body": { "mode": "raw", @@ -164301,8 +169577,9 @@ "language": "json" } }, - "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" + "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}" }, + "description": "Removes all references of the specified agent (ciUserId) from greeting files in the given organization. Typically invoked when an agent is deleted or unassigned. in a given organization.", "header": [ { "key": "Content-Type", @@ -164355,7 +169632,7 @@ "language": "json" } }, - "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" + "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}" }, "header": [ { @@ -164390,7 +169667,7 @@ }, { "_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}", + "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": [ @@ -164409,7 +169686,7 @@ "language": "json" } }, - "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" + "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}" }, "header": [ { @@ -164463,7 +169740,7 @@ "language": "json" } }, - "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" + "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}" }, "header": [ { @@ -164517,7 +169794,7 @@ "language": "json" } }, - "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" + "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}" }, "header": [ { @@ -164571,7 +169848,7 @@ "language": "json" } }, - "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" + "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}" }, "header": [ { @@ -164625,7 +169902,7 @@ "language": "json" } }, - "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" + "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}" }, "header": [ { @@ -164679,7 +169956,7 @@ "language": "json" } }, - "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" + "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}" }, "header": [ { @@ -164737,7 +170014,7 @@ ], "query": [ { - "description": "Indicates if the URL for downloading Greeting Fileshould be included in the response.", + "description": "Indicates whether the URL for downloading the greeting file should be included in the response.", "key": "includeUrl", "value": "" } @@ -164790,7 +170067,7 @@ ], "query": [ { - "description": "Indicates if the URL for downloading Greeting Fileshould be included in the response.", + "description": "Indicates whether the URL for downloading the greeting file should be included in the response.", "key": "includeUrl", "value": "" } @@ -164842,7 +170119,7 @@ ], "query": [ { - "description": "Indicates if the URL for downloading Greeting Fileshould be included in the response.", + "description": "Indicates whether the URL for downloading the greeting file should be included in the response.", "key": "includeUrl", "value": "" } @@ -164894,7 +170171,7 @@ ], "query": [ { - "description": "Indicates if the URL for downloading Greeting Fileshould be included in the response.", + "description": "Indicates whether the URL for downloading the greeting file should be included in the response.", "key": "includeUrl", "value": "" } @@ -164946,7 +170223,7 @@ ], "query": [ { - "description": "Indicates if the URL for downloading Greeting Fileshould be included in the response.", + "description": "Indicates whether the URL for downloading the greeting file should be included in the response.", "key": "includeUrl", "value": "" } @@ -164998,7 +170275,7 @@ ], "query": [ { - "description": "Indicates if the URL for downloading Greeting Fileshould be included in the response.", + "description": "Indicates whether the URL for downloading the greeting file should be included in the response.", "key": "includeUrl", "value": "" } @@ -165050,7 +170327,7 @@ ], "query": [ { - "description": "Indicates if the URL for downloading Greeting Fileshould be included in the response.", + "description": "Indicates whether the URL for downloading the greeting file should be included in the response.", "key": "includeUrl", "value": "" } @@ -165085,7 +170362,7 @@ }, "raw": "{\n \"agentPersonalGreetingInfo\": {\n \"agentId\": \"\",\n \"contentType\": \"TEXT_PHP\",\n \"name\": \"\u202fZ\u2029\u202fa\u200a. \",\n \"organizationId\": \"D4D8cD07f38E-9dbBf7D0fE64c7F1073f\",\n \"id\": \"\",\n \"version\": \"\",\n \"blobId\": \"\",\n \"url\": \"\",\n \"attributeTag\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"agentActive\": \"\",\n \"ciUserId\": \"\",\n \"audioFile\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"audioFile\": \"\"\n}" }, - "description": "Update specific Greeting File by ID in a given organization.", + "description": "Update an existing Greeting File by ID in a given organization.", "header": [ { "key": "Content-Type", @@ -165600,7 +170877,7 @@ { "name": "Delete specific Greeting File by ID", "request": { - "description": "Delete an existing Greeting File by ID for a given organization.", + "description": "Delete an existing Greeting File by ID in a given organization.", "header": [ { "key": "Accept", @@ -166408,8 +171685,9 @@ ] }, { - "name": "get All Config With Meta Data", + "name": "List Greeting Files", "request": { + "description": "Retrieve a list of Greeting Files in a given organization.", "header": [ { "key": "Accept", @@ -166429,7 +171707,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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 fields are: firstName, lastName, email, ciUserId, and attributeTag.\n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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": "" }, @@ -166454,7 +171732,7 @@ "value": "100" }, { - "description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled.", + "description": "If includeAgentDetails is set to true, projection, filtering, searching, and sorting on the agent's firstName, lastName, and email will be enabled.", "key": "includeAgentDetails", "value": "false" } @@ -166502,7 +171780,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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 fields are: firstName, lastName, email, ciUserId, and attributeTag.\n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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": "" }, @@ -166527,7 +171805,7 @@ "value": "100" }, { - "description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled.", + "description": "If includeAgentDetails is set to true, projection, filtering, searching, and sorting on the agent's firstName, lastName, and email will be enabled.", "key": "includeAgentDetails", "value": "false" } @@ -166575,7 +171853,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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 fields are: firstName, lastName, email, ciUserId, and attributeTag.\n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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": "" }, @@ -166600,7 +171878,7 @@ "value": "100" }, { - "description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled.", + "description": "If includeAgentDetails is set to true, projection, filtering, searching, and sorting on the agent's firstName, lastName, and email will be enabled.", "key": "includeAgentDetails", "value": "false" } @@ -166648,7 +171926,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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 fields are: firstName, lastName, email, ciUserId, and attributeTag.\n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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": "" }, @@ -166673,7 +171951,7 @@ "value": "100" }, { - "description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled.", + "description": "If includeAgentDetails is set to true, projection, filtering, searching, and sorting on the agent's firstName, lastName, and email will be enabled.", "key": "includeAgentDetails", "value": "false" } @@ -166721,7 +171999,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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 fields are: firstName, lastName, email, ciUserId, and attributeTag.\n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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": "" }, @@ -166746,7 +172024,7 @@ "value": "100" }, { - "description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled.", + "description": "If includeAgentDetails is set to true, projection, filtering, searching, and sorting on the agent's firstName, lastName, and email will be enabled.", "key": "includeAgentDetails", "value": "false" } @@ -166794,7 +172072,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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 fields are: firstName, lastName, email, ciUserId, and attributeTag.\n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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": "" }, @@ -166819,7 +172097,7 @@ "value": "100" }, { - "description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled.", + "description": "If includeAgentDetails is set to true, projection, filtering, searching, and sorting on the agent's firstName, lastName, and email will be enabled.", "key": "includeAgentDetails", "value": "false" } @@ -166867,7 +172145,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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 fields are: firstName, lastName, email, ciUserId, and attributeTag.\n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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": "" }, @@ -166892,7 +172170,7 @@ "value": "100" }, { - "description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled.", + "description": "If includeAgentDetails is set to true, projection, filtering, searching, and sorting on the agent's firstName, lastName, and email will be enabled.", "key": "includeAgentDetails", "value": "false" } @@ -166911,7 +172189,7 @@ ] }, { - "name": "Create a new Greeting File using v2 API", + "name": "Create a new Greeting File", "request": { "body": { "mode": "raw", @@ -166923,6 +172201,7 @@ }, "raw": "{\n \"agentPersonalGreetingInfo\": {\n \"agentId\": \"\",\n \"contentType\": \"AUDIO_X_WAV\",\n \"name\": \"\ufeffzh-z\\u000btrt\",\n \"organizationId\": \"CdEA0EaeF10eeCD35Eb2-2142C7166fA5\",\n \"id\": \"\",\n \"version\": \"\",\n \"blobId\": \"\",\n \"url\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"agentActive\": \"\",\n \"ciUserId\": \"\",\n \"greetingPurposeId\": \"\",\n \"greetingPurposeName\": \"\",\n \"audioFile\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"audioFile\": \"\"\n}" }, + "description": "Create a new Greeting File in a given organization.", "header": [ { "key": "Content-Type", @@ -167350,7 +172629,7 @@ ] }, { - "name": "Get specific Greeting File by ID using v2 API", + "name": "Get specific Greeting File by ID", "request": { "description": "Retrieve an existing Greeting File by ID in a given organization.", "header": [ @@ -167373,7 +172652,7 @@ ], "query": [ { - "description": "Indicates if the URL for downloading Greeting Fileshould be included in the response.", + "description": "Indicates whether the URL for downloading the greeting file should be included in the response.", "key": "includeUrl", "value": "" } @@ -167427,7 +172706,7 @@ ], "query": [ { - "description": "Indicates if the URL for downloading Greeting Fileshould be included in the response.", + "description": "Indicates whether the URL for downloading the greeting file should be included in the response.", "key": "includeUrl", "value": "" } @@ -167482,7 +172761,7 @@ ], "query": [ { - "description": "Indicates if the URL for downloading Greeting Fileshould be included in the response.", + "description": "Indicates whether the URL for downloading the greeting file should be included in the response.", "key": "includeUrl", "value": "" } @@ -167537,7 +172816,7 @@ ], "query": [ { - "description": "Indicates if the URL for downloading Greeting Fileshould be included in the response.", + "description": "Indicates whether the URL for downloading the greeting file should be included in the response.", "key": "includeUrl", "value": "" } @@ -167592,7 +172871,7 @@ ], "query": [ { - "description": "Indicates if the URL for downloading Greeting Fileshould be included in the response.", + "description": "Indicates whether the URL for downloading the greeting file should be included in the response.", "key": "includeUrl", "value": "" } @@ -167647,7 +172926,7 @@ ], "query": [ { - "description": "Indicates if the URL for downloading Greeting Fileshould be included in the response.", + "description": "Indicates whether the URL for downloading the greeting file should be included in the response.", "key": "includeUrl", "value": "" } @@ -167702,7 +172981,7 @@ ], "query": [ { - "description": "Indicates if the URL for downloading Greeting Fileshould be included in the response.", + "description": "Indicates whether the URL for downloading the greeting file should be included in the response.", "key": "includeUrl", "value": "" } @@ -167727,7 +173006,7 @@ ] }, { - "name": "Update specific Greeting File by ID using v2 API", + "name": "Update specific Greeting File by ID", "request": { "body": { "mode": "raw", @@ -167739,7 +173018,7 @@ }, "raw": "{\n \"agentPersonalGreetingInfo\": {\n \"agentId\": \"\",\n \"contentType\": \"AUDIO_X_WAV\",\n \"name\": \"\ufeffzh-z\\u000btrt\",\n \"organizationId\": \"CdEA0EaeF10eeCD35Eb2-2142C7166fA5\",\n \"id\": \"\",\n \"version\": \"\",\n \"blobId\": \"\",\n \"url\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"agentActive\": \"\",\n \"ciUserId\": \"\",\n \"greetingPurposeId\": \"\",\n \"greetingPurposeName\": \"\",\n \"audioFile\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"audioFile\": \"\"\n}" }, - "description": "Update specific Greeting File by ID in a given organization.", + "description": "Update an existing Greeting File by ID in a given organization.", "header": [ { "key": "Content-Type", @@ -168277,9 +173556,9 @@ ] }, { - "name": "Delete specific Greeting File by ID using v2 API", + "name": "Delete specific Greeting File by ID", "request": { - "description": "Delete an existing Greeting File by ID for a given organization.", + "description": "Delete an existing Greeting File by ID in a given organization.", "header": [ { "key": "Accept", @@ -168643,7 +173922,7 @@ ] }, { - "name": "Partially update Greeting File by ID using v2 API", + "name": "Partially update Greeting File by ID", "request": { "body": { "mode": "raw", @@ -169131,9 +174410,9 @@ ] }, { - "name": "List Greeting File(s)", + "name": "List Greeting Files", "request": { - "description": "Retrieve a list of Greeting File(s) in a given organization.", + "description": "Retrieve a list of Greeting Files in a given organization.", "header": [ { "key": "Accept", @@ -169153,7 +174432,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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 fields are: firstName, lastName, email, ciUserId, and attributeTag.\n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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": "" }, @@ -169178,7 +174457,7 @@ "value": "100" }, { - "description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled.", + "description": "If includeAgentDetails is set to true, projection, filtering, searching, and sorting on the agent's firstName, lastName, and email will be enabled.", "key": "includeAgentDetails", "value": "false" } @@ -169226,7 +174505,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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 fields are: firstName, lastName, email, ciUserId, and attributeTag.\n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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": "" }, @@ -169251,7 +174530,7 @@ "value": "100" }, { - "description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled.", + "description": "If includeAgentDetails is set to true, projection, filtering, searching, and sorting on the agent's firstName, lastName, and email will be enabled.", "key": "includeAgentDetails", "value": "false" } @@ -169300,7 +174579,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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 fields are: firstName, lastName, email, ciUserId, and attributeTag.\n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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": "" }, @@ -169325,7 +174604,7 @@ "value": "100" }, { - "description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled.", + "description": "If includeAgentDetails is set to true, projection, filtering, searching, and sorting on the agent's firstName, lastName, and email will be enabled.", "key": "includeAgentDetails", "value": "false" } @@ -169374,7 +174653,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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 fields are: firstName, lastName, email, ciUserId, and attributeTag.\n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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": "" }, @@ -169399,7 +174678,7 @@ "value": "100" }, { - "description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled.", + "description": "If includeAgentDetails is set to true, projection, filtering, searching, and sorting on the agent's firstName, lastName, and email will be enabled.", "key": "includeAgentDetails", "value": "false" } @@ -169448,7 +174727,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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 fields are: firstName, lastName, email, ciUserId, and attributeTag.\n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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": "" }, @@ -169473,7 +174752,7 @@ "value": "100" }, { - "description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled.", + "description": "If includeAgentDetails is set to true, projection, filtering, searching, and sorting on the agent's firstName, lastName, and email will be enabled.", "key": "includeAgentDetails", "value": "false" } @@ -169522,7 +174801,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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 fields are: firstName, lastName, email, ciUserId, and attributeTag.\n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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": "" }, @@ -169547,7 +174826,7 @@ "value": "100" }, { - "description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled.", + "description": "If includeAgentDetails is set to true, projection, filtering, searching, and sorting on the agent's firstName, lastName, and email will be enabled.", "key": "includeAgentDetails", "value": "false" } @@ -169596,7 +174875,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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 fields are: firstName, lastName, email, ciUserId, and attributeTag.\n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this 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": "" }, @@ -169621,7 +174900,7 @@ "value": "100" }, { - "description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled.", + "description": "If includeAgentDetails is set to true, projection, filtering, searching, and sorting on the agent's firstName, lastName, and email will be enabled.", "key": "includeAgentDetails", "value": "false" } @@ -169826,7 +175105,7 @@ "language": "json" } }, - "raw": "[\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" + "raw": "[\n {\n \"op\": \"remove\",\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. \n\nFor a more information on Patch Requests, see this [JSON PATCH guide](https://jsonpatch.com). \n\nRole and Scope: Requires id full admin role with cjp:config_write or any role with cjp:user or cjp:config_write scope.", "header": [ @@ -169886,7 +175165,7 @@ "language": "json" } }, - "raw": "[\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" }, "header": [ { @@ -169940,7 +175219,7 @@ "language": "json" } }, - "raw": "[\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" }, "header": [ { @@ -169994,7 +175273,7 @@ "language": "json" } }, - "raw": "[\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" }, "header": [ { @@ -170053,7 +175332,7 @@ "language": "json" } }, - "raw": "[\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" + "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" }, "header": [ { @@ -171902,43 +177181,29309 @@ "code": 500, "cookie": [], "header": [], - "name": "Internal error", + "name": "Internal error", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"override\": \"\",\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 \"socialId\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "person", + "merge-identities", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/person/merge-identities/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Internal Server Error" + } + ] + }, + { + "name": "Search for an Identity via aliases", + "request": { + "description": "Get one or more Person Details searched by aliases in JDS. Multiple aliases should be separated by a comma.\n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or it requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "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": "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", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + } + ] + } + }, + "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, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Success", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + } + ] + } + }, + "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", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + } + ] + } + }, + "status": "Internal Server Error" + } + ] + } + ], + "name": "Journey - Customer Identification API" + }, + { + "item": [ + { + "name": "Journey Event Posting", + "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 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. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or any role with cjp:config_write scope.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "publish", + "v1", + "api", + "event" + ], + "query": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + } + ], + "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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 \"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", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "publish", + "v1", + "api", + "event" + ], + "query": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + } + ], + "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "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 \"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", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "publish", + "v1", + "api", + "event" + ], + "query": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + } + ], + "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource already exists", + "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", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "publish", + "v1", + "api", + "event" + ], + "query": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + } + ], + "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"organizationId\": \"\",\n \"workspaceId\": \"\"\n },\n \"data\": {\n \"message\": \"\"\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 \"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", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "publish", + "v1", + "api", + "event" + ], + "query": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + } + ], + "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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 \"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", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "publish", + "v1", + "api", + "event" + ], + "query": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + } + ], + "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + } + }, + "status": "Too Many Requests" + } + ] + } + ], + "name": "Journey - Data Ingestion API" + }, + { + "item": [ + { + "name": "Get A specific Template searched by template id", + "request": { + "description": "Get Template details by template Id in JDS. \n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_write scope.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "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", + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "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", + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "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": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Success", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "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. \n\nRole and Scope: Requires id full admin or any role with 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": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "Template ID", + "key": "templateId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"200 OK\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request", + "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", + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_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": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Ok", + "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", + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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 \"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", + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Internal Server Error" + } + ] + }, + { + "name": "Delete Template by template Id", + "request": { + "description": "Delete Template By template id in JDS. \n\nRole and Scope: Requires id full admin or any role with cjp:config_write scope.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "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": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "Template ID", + "key": "templateId", + "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", + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "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", + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Not Found" + }, + { + "_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": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Success", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "OK" + } + ] + }, + { + "name": "Get All Template Details", + "request": { + "description": "Get Template details by Organization Id and workspaceId in JDS. \n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "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/documentation/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": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + } + ] + } + }, + "response": [ + { + "_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/documentation/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": [ + { + "description": "Workspace ID", + "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/documentation/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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "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 \"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", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "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/documentation/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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "OK" + } + ] + }, + { + "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. \n\n **Role and Scope**: Requires id full admin or any role with cjp:config_write scope.\n\n **Template with single rule**: \n ```\n {\n \"name\": \"ClosedCaller\",\n \"attributes\": [\n {\n \"version\": \"0.1\",\n \"event\": \"Closed Queue\",\n \"metaDataType\": \"string\",\n \"metaData\": \"category\",\n \"limit\": 100,\n \"displayName\": \"ClosedCaller\",\n \"lookBackDurationType\": \"minutes\",\n \"lookBackPeriod\": 5,\n \"aggregationMode\": \"Count\",\n \"rules\": {\n \"logic\": \"SINGLE\",\n \"condition\": \"Closed Queue,category,string,Value EQ Closed\"\n },\n \"widgetAttributes\": {\n \"type\": \"table\"\n },\n \"verbose\": false\n }\n ]\n }\n ```\n\n\n **Example Event:** \n ```\n {\n \"id\": \"{{$guid}}\",\n \"specversion\": \"1.0\",\n \"type\": \"Closed Queue\",\n \"source\": \"Voice%20Contact\",\n \"identity\": \"jes@gmail.com\",\n \"identitytype\": \"email\",\n \"datacontenttype\": \"application/json\",\n \"data\": {\n \"Email\": \"jes@gmail.com\",\n \"CallsQueuedNow\": \"Use GetQueueInfoNode Values\",\n \"OldestCallTime\": \"Use GetQueueInfoNode Values\",\n \"LoggedOnAgents\": \"Use GetQueueInfoNode Values\",\n \"PIQ\": \"Use GetQueueInfoNode Values\",\n \"EWT\": \"Use GetQueueInfoNode Values\",\n \"category\": \"Closed\",\n \"origin\": \"Past Due - 1st Notification\",\n \"channelType\": \"QueueCall\",\n \"channelBreakout\": \"voice\"\n }\n }\n ```\n\n\n **Key components of the rule:** \n * template.event: This refers to the specific event type you want to match (e.g., \"Closed Queue\").\n * event.type: This refers to the actual event type present in the event data.\n * event.data: This is the dictionary/object containing all the metadata associated with the event.\n * template.rules.condition - category: This is the specific metadata field you want to compare within event.data.\n * template.rules.condition - string: This indicates that the category metadata is a string type.\n * template.rules.condition - Value EQ Closed: This defines the condition: the value of the category field (as a string) must be equal to \"Closed\".\n\n\n **Evaluation process:** \n 1. The rule checks if template.event matches the event.type in the incoming event.\n 2. If they match, the rule retrieves the value of the category field from event.data.\n 3. It then compares the value of category (treated as a string) to \"Closed\" using an equality operator (EQ).\n 4. If the values are equal, the condition evaluates to True and creates a progressive profile for the identity. Otherwise, it evaluates to False.\n \n The template has lookBackPeriod and lookBackDurationType which decide how long to look back for the calculation. In the above template, it fetches events triggered in the last 5 minutes and performs the aggregation mode on the data received from rules.\n \n * When the aggregation mode is Value, the profile result will have the value of the rule as the output.\n * When the aggregation mode is Count, the profile will have the count of events with category closed in the past 5 minutes.\n * When the aggregation mode is Distinct, the profile will have the value closed.\n * When aggregation mode is Sum, the data type should be Integer or double and it will be the sum of all matching values in the last 5 minutes.\n * When aggregation mode is Max, the data type should be Integer or double and it will be the max of all matching values in the last 5 minutes.\n * When aggregation mode is Min, the data type should be Integer or double and it will be the min of all matching values in the last 5 minutes.\n * When aggregation mode is Average, the data type should be Integer or double and it will be the average of all matching values in the last 5 minutes.\n\n\n **Example template with multiple rules :** \n ```\n1. {\n2. \"name\": \"sample-template-multi-condition\",\n3. \"attributes\": [\n4. {\n5. \"version\": \"0.1\",\n6. \"event\": \"Quote\",\n7. \"metaDataType\": \"string\",\n8. \"metaData\": \"email\",\n9. \"limit\": 1,\n10. \"displayName\": \"Email\",\n11. \"lookBackDurationType\": \"days\",\n12. \"lookBackPeriod\": 50,\n13. \"aggregationMode\": \"Value\",\n14. \"rules\": {\n15. \"args\": [\n16. \"Quote,isEV,string,Value EQ Yes\",\n17. \"Quote,isEV,string,Value EQ No\",\n18. {\n19. \"args\": [\n20. \"Quote,make,string,Value EQ Honda\",\n21. \"Quote,model,string,Value EQ CR-V\"\n22. ],\n23. \"logic\": \"AND\"\n24. }\n25. ],\n26. \"logic\": \"OR\"\n27. },\n28. \"widgetAttributes\": {\n29. \"type\": \"table\"\n30. },\n31. \"verbose\": false\n32. }\n33. ]\n34. }\n ```\n1. In the above template we have multiple rules.\n2. The arguments in line 20 and 21 are evaluated with logical AND condition.\n3. Then arguments in line 16 and 17 along with the result for 20 AND 21 are evaluated with logical OR (line 26).\n", + "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": "Workspace ID", + "key": "workspaceId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"200 OK\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request", + "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", + "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": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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 \"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", + "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": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_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, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Created", + "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", + "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": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Created" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "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 \"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", + "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": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Get A specific Template searched by template name", + "request": { + "description": "Get Template details by template Name in JDS. \n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "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": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "Template Name", + "key": "templateName", + "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", + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template Name", + "key": "templateName" + } + ] + } + }, + "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", + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template Name", + "key": "templateName" + } + ] + } + }, + "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": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Success", + "originalRequest": { + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template Name", + "key": "templateName" + } + ] + } + }, + "status": "OK" + } + ] + }, + { + "name": "Historic Progressive Profile View by Template Name", + "request": { + "description": "Get Historic Progressive Profile View in JDS. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "api", + "progressive-profile-view", + "workspace-id", + ":workspaceId", + "person-id", + ":personId", + "template-name", + ":templateName" + ], + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "Person ID", + "key": "personId", + "value": "" + }, + { + "description": "Template Name", + "key": "templateName", + "value": "" + } + ] + } + }, + "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, + "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", + "progressive-profile-view", + "workspace-id", + ":workspaceId", + "person-id", + ":personId", + "template-name", + ":templateName" + ], + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Person ID", + "key": "personId" + }, + { + "description": "Template Name", + "key": "templateName" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Not Found", + "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-name", + ":templateName" + ], + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Person ID", + "key": "personId" + }, + { + "description": "Template Name", + "key": "templateName" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"200 OK\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request", + "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-name", + ":templateName" + ], + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Person ID", + "key": "personId" + }, + { + "description": "Template Name", + "key": "templateName" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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", + "progressive-profile-view", + "workspace-id", + ":workspaceId", + "person-id", + ":personId", + "template-name", + ":templateName" + ], + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Person ID", + "key": "personId" + }, + { + "description": "Template Name", + "key": "templateName" + } + ] + } + }, + "status": "Internal Server Error" + } + ] + }, + { + "name": "Historic Progressive Profile View", + "request": { + "description": "Get Historic Progressive Profile View in JDS. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "Person ID", + "key": "personId", + "value": "" + }, + { + "description": "Template ID", + "key": "templateId", + "value": "" + } + ] + } + }, + "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, + "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", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Person ID", + "key": "personId" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Person ID", + "key": "personId" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Not Found", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Person ID", + "key": "personId" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"200 OK\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Person ID", + "key": "personId" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Bad Request" + } + ] + }, + { + "name": "Historic Progressive Profile View By 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": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "Identity", + "key": "identity", + "value": "" + }, + { + "description": "Template Name", + "key": "templateName", + "value": "" + } + ] + } + }, + "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, + "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", + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Identity", + "key": "identity" + }, + { + "description": "Template Name", + "key": "templateName" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Not Found", + "originalRequest": { + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Identity", + "key": "identity" + }, + { + "description": "Template Name", + "key": "templateName" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"200 OK\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request", + "originalRequest": { + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Identity", + "key": "identity" + }, + { + "description": "Template Name", + "key": "templateName" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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", + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Identity", + "key": "identity" + }, + { + "description": "Template Name", + "key": "templateName" + } + ] + } + }, + "status": "Internal Server Error" + } + ] + }, + { + "name": "Historic Progressive Profile View By Template Id", + "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-id", + ":templateId" + ], + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "identity", + "key": "identity", + "value": "" + }, + { + "description": "Template ID", + "key": "templateId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "identity", + "key": "identity" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"200 OK\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request", + "originalRequest": { + "header": [ + { + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "identity", + "key": "identity" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_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": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Ok", + "originalRequest": { + "header": [ + { + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "identity", + "key": "identity" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Not Found", + "originalRequest": { + "header": [ + { + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "identity", + "key": "identity" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Stream Progressive profile Views By Template Name", + "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. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "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": "Template Name", + "key": "templateName", + "value": "" + } + ] + } + }, + "response": [ + { + "_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, + "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", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + }, + { + "description": "Template Name", + "key": "templateName" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + }, + { + "description": "Template Name", + "key": "templateName" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + }, + { + "description": "Template Name", + "key": "templateName" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + }, + { + "description": "Template Name", + "key": "templateName" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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-name", + ":templateName" + ], + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + }, + { + "description": "Template Name", + "key": "templateName" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Stream Progressive profile Views By Template Id", + "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. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "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": "Template ID", + "key": "templateId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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-id", + ":templateId" + ], + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Conflict" + }, + { + "_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, + "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", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "Historic Journey Events", + "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. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "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/documentation/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/documentation/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": "Workspace ID", + "key": "workspaceId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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", + "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/documentation/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/documentation/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": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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", + "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/documentation/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/documentation/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": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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", + "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/documentation/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/documentation/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": "Workspace ID", + "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/documentation/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/documentation/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": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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", + "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/documentation/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/documentation/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": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "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. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "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/documentation/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/documentation/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": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "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 \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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", + "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/documentation/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/documentation/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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + } + ] + } + }, + "status": "Not Found" + }, + { + "_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/documentation/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/documentation/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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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/documentation/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/documentation/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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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/documentation/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/documentation/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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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/documentation/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/documentation/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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "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" + } + ] + } + }, + "status": "Conflict" + } + ] + } + ], + "name": "Journey - Profile Creation & Insights API" + }, + { + "item": [ + { + "name": "Get WXCC Subscription", + "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", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "wxcc-subscription", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ + "admin", + "v1", + "api", + "wxcc-subscription", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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", + "wxcc-subscription", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_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, + "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", + "wxcc-subscription", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ + "admin", + "v1", + "api", + "wxcc-subscription", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ + "admin", + "v1", + "api", + "wxcc-subscription", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Conflict" + } + ] + }, + { + "name": "Create WXCC Subscription", + "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", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Internal server 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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "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, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Created", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Created" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource already exists", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Conflict" + } + ] + }, + { + "name": "Delete WXCC Subscription", + "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", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Internal server error", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource 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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource already exists", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "No Content", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "OK" + } + ] + } + ], + "name": "Journey - Subscription API" + }, + { + "item": [ + { + "name": "Get all Journey Actions", + "request": { + "description": "Get all Journey Actions in JDS. \n\nRole and Scope: Requires id full admin or any role with cjp:config_write or cjp:config_read scope.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "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 \"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": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Success", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "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": [ + { + "description": "Workspace ID", + "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": "" + }, + { + "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": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "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" + ], + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Get all Journey Actions for a template", + "request": { + "description": "Get all Journey Actions for a template in JDS. \n\nRole and Scope: It requires id full admin or any role with cjp:config_read or cjp:config_write scope.", + "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": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "Template ID", + "key": "templateId", + "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 \"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": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Success", + "originalRequest": { + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "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", + "journey-actions", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" + ], + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "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", + "journey-actions", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" + ], + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Internal Server Error" + } + ] + }, + { + "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 },\n {\n \"type\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" + }, + "description": "Create a new Journey Action in JDS. \n\n **Role and Scope**: It requires id full admin or any role with cjp:config_write scope.\n\n **Sample Input for Creating new Journey action**: \n ```\n {\n \"name\": \"Closed Queue Action\",\n \"cooldownPeriodInMinutes\": 1,\n \"rules\": {\n \"logic\": \"SINGLE\",\n \"condition\": \"Closed Queue,category,string,Value GTE 2\"\n },\n \"actionTriggers\": [\n {\n \"type\": \"Webhook\",\n \"webhookURL\": \"https://hooks.us.webexconnect.io/events/6M347NJ6\",\n \"attributes\": {\n \"httpverb\": \"post\",\n \"requestbody\": \"{\\\"SMS\\\":\\\"12263762551\\\",\\\"callID\\\":\\\"\\\",\\\"MessageToSend\\\":\\\"Hello there!\\\"}\"\n }\n }\n ],\n \"isActive\": true\n }\n ```\nThe action trigger's evaluation process is predicated on the progressive profile that has been established. \nIn this specific action trigger, the rule assessment verifies whether the progressive profile value from the prior template evaluation was in excess of 2. \nIf this condition is met, the webhook is subsequently activated.\n\n\nPrior to rule evaluation for actions, several conditions must be satisfied. \nFirstly, the event associated with the template must align with the rule event, which, in this case, is 'Closed Queue'. \nSecondly, the metadata assigned to the template must correspond with the metadata set by the rules, which in this context, is 'category'. \nThirdly, the aggregation mode of the template must be equivalent to the rules' aggregation mode, which is 'value' in this instance. \nFinally, the operator of the template's aggregation mode must match those defined for 'value'. \nIn this scenario, it is 'GTE' (greater than or equal), which is an accepted value for 'value'.\n", + "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": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "Template ID", + "key": "templateId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"200 OK\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "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 },\n {\n \"type\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" + }, + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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 \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" + }, + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_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, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Accepted", + "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 },\n {\n \"type\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" + }, + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + } + ] + } + }, + "status": "Created" + } + ] + }, + { + "name": "Get specific Journey Action By Name", + "request": { + "description": "Get specific Journey Action By Name in JDS. \n\nRole and Scope:It requires id full admin or any role with cjp:config_read or cjp:config_write scope.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "Template ID", + "key": "templateId", + "value": "" + }, + { + "description": "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + }, + { + "description": "Action Name", + "key": "actionName" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_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}}" + ], + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + }, + { + "description": "Action Name", + "key": "actionName" + } + ] + } + }, + "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", + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + }, + { + "description": "Action Name", + "key": "actionName" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Get specific Journey Action By ActionId", + "request": { + "description": "Get specific Journey Action By ActionId in JDS. \n\nRole and Scope: It requires id full admin role with cjp:config_read or cjp:config_write scope.", + "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": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "Template ID", + "key": "templateId", + "value": "" + }, + { + "description": "Action ID", + "key": "actionId", + "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-id", + ":actionId" + ], + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + }, + { + "description": "Action ID", + "key": "actionId" + } + ] + } + }, + "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-id", + ":actionId" + ], + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + }, + { + "description": "Action ID", + "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}}" + ], + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + }, + { + "description": "Action ID", + "key": "actionId" + } + ] + } + }, + "status": "OK" + } + ] + }, + { + "name": "Update existing 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 },\n {\n \"type\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" + }, + "description": "Update existing Journey Action in JDS. \n\nRole and Scope: It requires id full admin or any role with 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", + "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": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "Template ID", + "key": "templateId", + "value": "" + }, + { + "description": "Action ID", + "key": "actionId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"200 OK\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "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 },\n {\n \"type\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + }, + { + "description": "Action ID", + "key": "actionId" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_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, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Accepted", + "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 },\n {\n \"type\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + }, + { + "description": "Action ID", + "key": "actionId" + } + ] + } + }, + "status": "Created" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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 \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + }, + { + "description": "Action ID", + "key": "actionId" + } + ] + } + }, + "status": "Internal Server Error" + } + ] + }, + { + "name": "Delete Journey Action configuration By ActionId", + "request": { + "description": "Delete Journey Action configuration By ActionId in JDS. \n\nRole and Scope: It requires id full admin role with 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": "Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "Template ID", + "key": "templateId", + "value": "" + }, + { + "description": "Action ID", + "key": "actionId", + "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", + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + }, + { + "description": "Action ID", + "key": "actionId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_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}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Success", + "originalRequest": { + "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": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + }, + { + "description": "Action ID", + "key": "actionId" + } + ] + } + }, + "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": [ + { + "description": "Workspace ID", + "key": "workspaceId" + }, + { + "description": "Template ID", + "key": "templateId" + }, + { + "description": "Action ID", + "key": "actionId" + } + ] + } + }, + "status": "Not Found" + } + ] + } + ], + "name": "Journey - Trigger Actions API" + }, + { + "item": [ + { + "name": "Get Workspace", + "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", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + } + ] + } + }, + "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, + "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", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ + "admin", + "v1", + "api", + "workspace", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ + "admin", + "v1", + "api", + "workspace", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ + "admin", + "v1", + "api", + "workspace", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "Update Workspace", + "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", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "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}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "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", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "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": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "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", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Conflict" + } + ] + }, + { + "name": "Delete Workspace", + "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", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource already exists", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Internal server error", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_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": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Ok", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "variable": [ + { + "description": "Workspace ID", + "key": "workspaceId" + } + ] + } + }, + "status": "OK" + } + ] + }, + { + "name": "Get All Workspaces", + "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", + "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/documentation/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/workspace?filter=&sortBy=&sort=&page=&pageSize=" + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ + "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/documentation/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/workspace?filter=&sortBy=&sort=&page=&pageSize=" + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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/documentation/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/workspace?filter=&sortBy=&sort=&page=&pageSize=" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ + "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/documentation/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/workspace?filter=&sortBy=&sort=&page=&pageSize=" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ + "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/documentation/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/workspace?filter=&sortBy=&sort=&page=&pageSize=" + } + }, + "status": "Not Found" + }, + { + "_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/documentation/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/workspace?filter=&sortBy=&sort=&page=&pageSize=" + } + }, + "status": "OK" + } + ] + }, + { + "name": "Create Workspace", + "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", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace" + } + }, + "response": [ + { + "_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}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "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": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace" + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "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": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace" + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "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" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace" + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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" + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace" + } + }, + "status": "Internal Server Error" + } + ] + } + ], + "name": "Journey - Workspace management API" + }, + { + "description": "Operations for managing Do Not Contact (DNC) lists and phone number entries", + "item": [ + { + "name": "Add Phone Number to DNC List", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + }, + "description": "Adds a phone number to the specified Do Not Contact (DNC) list. This operation helps ensure compliance with applicable rules & regulations by preventing outbound calls to specific numbers.\n\n**Note:** Phone numbers must be in E.164 format (e.g., +1234567890). Duplicate entries will be rejected with a 409 error.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "variable": [ + { + "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName", + "value": "nFT" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"phoneNumber\": \"+655944\",\n \"source\": \"\",\n \"addedDate\": \"\",\n \"addedBy\": \"\",\n \"reason\": \"\",\n \"lastModified\": \"\"\n}", + "code": 201, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Phone number successfully added to the DNC list", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "variable": [ + { + "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + } + ] + } + }, + "status": "Created" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 403,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed. User lacks required permissions to manage DNC lists.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "variable": [ + { + "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 504,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 504, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "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 \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "variable": [ + { + "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 429,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Number of seconds to wait before retrying", + "type": "text/plain" + }, + "disabled": false, + "key": "Retry-After", + "value": "" + } + ], + "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 \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "variable": [ + { + "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 1002,\n \"message\": \"\",\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. An accompanying error message will explain further.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "variable": [ + { + "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 401,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "variable": [ + { + "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 503,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 503, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "variable": [ + { + "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 502,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 502, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "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 \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "variable": [ + { + "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 1005,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Not Found: The specified DNC list does not exist or the user does not have access to it.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "variable": [ + { + "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 409,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Conflict: The phone number already exists in the specified DNC list.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "variable": [ + { + "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 1006,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "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 \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "variable": [ + { + "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + } + ] + } + }, + "status": "Internal Server Error" + } + ] + }, + { + "name": "Get Phone Number from DNC List", + "request": { + "description": "Retrieves details of a specific phone number from the specified Do Not Contact (DNC) list. This operation allows you to check if a number is present in the list and view associated metadata.\n\n**Note:** Phone numbers must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName", + "value": "nFT" + }, + { + "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber", + "value": "+8342" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 429,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Number of seconds to wait before retrying", + "type": "text/plain" + }, + "disabled": false, + "key": "Retry-After", + "value": "" + } + ], + "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": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 1002,\n \"message\": \"\",\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. An accompanying error message will explain further.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 1005,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Not Found: The specified DNC list does not exist, the phone number is not found in the list, or the user does not have access to it.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 502,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 502, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "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" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 1006,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "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" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 503,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 503, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 401,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 504,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 504, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"phoneNumber\": \"+655944\",\n \"source\": \"\",\n \"addedDate\": \"\",\n \"addedBy\": \"\",\n \"reason\": \"\",\n \"lastModified\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Phone number details successfully retrieved from the DNC list", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 403,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed. User lacks required permissions to view DNC lists.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Forbidden" + } + ] + }, + { + "name": "Remove Phone Number from DNC List", + "request": { + "description": "Removes a phone number from the specified Do Not Contact (DNC) list. This operation allows administrators to remove numbers that should no longer be blocked from receiving calls.\n\n**Note:** Phone numbers must be URL-encoded and in E.164 format (e.g., +1234567890 for +1234567890). If the number doesn't exist in the list, a 404 error will be returned.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName", + "value": "nFT" + }, + { + "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber", + "value": "+8342" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 1006,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "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" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 403,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed. User lacks required permissions to manage DNC lists.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 502,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 502, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "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" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 503,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 503, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 401,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 429,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Number of seconds to wait before retrying", + "type": "text/plain" + }, + "disabled": false, + "key": "Retry-After", + "value": "" + } + ], + "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": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "Phone number successfully removed from the DNC list. No content is returned.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "No Content" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 1002,\n \"message\": \"\",\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. An accompanying error message will explain further.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 504,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 504, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 1005,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Not Found: The specified DNC list does not exist, the phone number is not found in the list, or the user does not have access to it.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "dncList", + ":dncListName", + "phoneNumber", + ":phoneNumber" + ], + "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "variable": [ + { + "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", + "key": "dncListName" + }, + { + "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", + "key": "phoneNumber" + } + ] + } + }, + "status": "Not Found" + } + ] + } + ], + "name": "DNC Management" + }, + { + "item": [ + { + "name": "Create a new Resource Collection", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "description": "Create a new resource collection in a given organization.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection", + "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 \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection", + "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": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection", + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection", + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection", + "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 \"name\": \"4\u00a02lgM\u2003\u2008t\",\n \"organizationId\": \"4c89048aeF9eB455-FbFC2d9fC96537b6\",\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}", + "code": 201, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "Created", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection", + "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, + "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 \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection", + "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": 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 \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection", + "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" + } + ] + }, + { + "name": "Bulk partial update Resource Collections", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"53e3dC0A6d5b-1fe9-D13d-e6dc01A8Ba9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"C947242F-c9FaA753-2Feb376C3a3Da628\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "description": "Update some or all properties for resource collections in bulk for a given organization.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/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": 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 \"organizationId\": \"53e3dC0A6d5b-1fe9-D13d-e6dc01A8Ba9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"C947242F-c9FaA753-2Feb376C3a3Da628\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/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 \"organizationId\": \"53e3dC0A6d5b-1fe9-D13d-e6dc01A8Ba9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"C947242F-c9FaA753-2Feb376C3a3Da628\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/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": 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 \"organizationId\": \"53e3dC0A6d5b-1fe9-D13d-e6dc01A8Ba9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"C947242F-c9FaA753-2Feb376C3a3Da628\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/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": "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 \"organizationId\": \"53e3dC0A6d5b-1fe9-D13d-e6dc01A8Ba9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"C947242F-c9FaA753-2Feb376C3a3Da628\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/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": 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 \"organizationId\": \"53e3dC0A6d5b-1fe9-D13d-e6dc01A8Ba9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"C947242F-c9FaA753-2Feb376C3a3Da628\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/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 \"organizationId\": \"53e3dC0A6d5b-1fe9-D13d-e6dc01A8Ba9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"C947242F-c9FaA753-2Feb376C3a3Da628\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/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": 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 \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"53e3dC0A6d5b-1fe9-D13d-e6dc01A8Ba9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"C947242F-c9FaA753-2Feb376C3a3Da628\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/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": "Not Found" + } + ] + }, + { + "name": "Update resource with default resource collection", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceId\": \"\",\n \"resourceType\": \"\",\n \"resourceCollections\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" + }, + "description": "Update resource with default resource collection. Ensure resource should not associated to any resource collection and resource should not be updated and not older than 15 min. Only single Resource Collection is allowed to update.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + "update-resource" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceId\": \"\",\n \"resourceType\": \"\",\n \"resourceCollections\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + "update-resource" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", + "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": 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 \"resourceId\": \"\",\n \"resourceType\": \"\",\n \"resourceCollections\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + "update-resource" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", + "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": 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 \"resourceId\": \"\",\n \"resourceType\": \"\",\n \"resourceCollections\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + "update-resource" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", + "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 \"resourceId\": \"\",\n \"resourceType\": \"\",\n \"resourceCollections\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + "update-resource" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", + "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 \"response\": [\n {\n \"id\": \"\",\n \"resourceType\": \"\",\n \"status\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"resourceType\": \"\",\n \"status\": \"\",\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": 201, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "Created", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceId\": \"\",\n \"resourceType\": \"\",\n \"resourceCollections\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + "update-resource" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", + "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": 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 \"resourceId\": \"\",\n \"resourceType\": \"\",\n \"resourceCollections\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + "update-resource" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", + "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 \"resourceId\": \"\",\n \"resourceType\": \"\",\n \"resourceCollections\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + "update-resource" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", + "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 Resource Collection by ID", + "request": { + "description": "Retrieve an existing Resource Collection by ID in a given organization.", + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "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 Resource Collection.", + "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", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "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", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "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", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "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": 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", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "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", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "key": "id" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"name\": \"4\u00a02lgM\u2003\u2008t\",\n \"organizationId\": \"4c89048aeF9eB455-FbFC2d9fC96537b6\",\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}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "key": "id" + } + ] + } + }, + "status": "OK" + } + ] + }, + { + "name": "Update specific Resource Collection by ID", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "description": "Update an existing resource collection by ID in a given organization.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "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 Resource Collection.", + "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 \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "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": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "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": 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 \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "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": 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 \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "key": "id" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"name\": \"4\u00a02lgM\u2003\u2008t\",\n \"organizationId\": \"4c89048aeF9eB455-FbFC2d9fC96537b6\",\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}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "key": "id" + } + ] + } + }, + "status": "OK" + } + ] + }, + { + "name": "Delete specific Resource Collection by ID", + "request": { + "description": "Delete an existing resource collection by ID in a given organization.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "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 Resource Collection.", + "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", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "key": "id" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "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, + "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", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "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": 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", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "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": 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", + "resource-collection", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Resource Collection.", + "key": "id" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "List references for a specific Resource Collection", + "request": { + "description": "Retrieve a list of all entities that have reference to an existing resource collection by ID in a given organization.", + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "resource-collection", + ":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/resource-collection/: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": "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", + "resource-collection", + ":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/resource-collection/: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": 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", + "resource-collection", + ":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/resource-collection/: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": 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", + "resource-collection", + ":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/resource-collection/: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": 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", + "resource-collection", + ":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/resource-collection/: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" + }, + { + "_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", + "resource-collection", + ":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/resource-collection/: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 \"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", + "resource-collection", + ":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/resource-collection/: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" + } + ] + }, + { + "name": "List Resource Collections", + "request": { + "description": "Retrieve a list of resource collections in a given organization.", + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v2", + "resource-collection" + ], + "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.", + "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/resource-collection?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": "text", + "body": "{\n \"meta\": {\n \"orgid\": \"7a3DfC3F-616CEfd184De-949c19bdbF3b\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {}\n },\n \"data\": [\n {\n \"name\": \"pkIDn\u00a0 67j\u2002\",\n \"organizationId\": \"9Cb2c2E8208eF8e5-48AdfA5eA2ccD852\",\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 \"name\": \"q\u3000ul\\u000bm\u2000ie\",\n \"organizationId\": \"5f12ef3Dec0caCacc407-acaF5BCfCE2C\",\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}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v2", + "resource-collection" + ], + "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.", + "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/resource-collection?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": 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", + "resource-collection" + ], + "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.", + "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/resource-collection?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" + }, + { + "_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", + "resource-collection" + ], + "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.", + "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/resource-collection?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": 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", + "resource-collection" + ], + "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.", + "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/resource-collection?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": 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", + "resource-collection" + ], + "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.", + "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/resource-collection?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", + "resource-collection" + ], + "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.", + "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/resource-collection?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" + } + ] + } + ], + "name": "Resource Collection" + }, + { + "description": "Operations for managing contact lists and contacts", + "item": [ + { + "name": "Create contact list", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"supportedChannels\": [\n \"Email\",\n \"Voice\"\n ],\n \"activationTimeLagMinutes\": \"\",\n \"activationDateTime\": \"\"\n}" + }, + "description": "Creates and activates a contact list for a campaign. The system can activate a contact list even if there are no contact records within it.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contact-list" + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list", + "variable": [ + { + "description": "Campaign ID to which the contact list belongs.", + "key": "campaignId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Invalid request", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"supportedChannels\": [\n \"Email\",\n \"Voice\"\n ],\n \"activationTimeLagMinutes\": \"\",\n \"activationDateTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contact-list" + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list", + "variable": [ + { + "description": "Campaign ID to which the contact list belongs.", + "key": "campaignId" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"outcome\": \"Success\",\n \"statusCode\": \"\",\n \"contactListId\": \"\"\n}", + "code": 201, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Contact list created successfully", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"supportedChannels\": [\n \"Email\",\n \"Voice\"\n ],\n \"activationTimeLagMinutes\": \"\",\n \"activationDateTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contact-list" + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list", + "variable": [ + { + "description": "Campaign ID to which the contact list belongs.", + "key": "campaignId" + } + ] + } + }, + "status": "Created" + } + ] + }, + { + "name": "Create contacts within a contact list", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"contacts\": [\n {\n \"contactAttributes\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"contactAttributes\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}" + }, + "description": "Creates contacts within a contact list (only if that contact list was created using API method). If the contact record is invalid, it will be added as INVALID and reflected in the 'Processed' and 'Invalid' counts. This is an Asynchronous operation. The values within the 'contactAttributes' param should conform to datatypes of the contact attributes as specified in the 'Field mapping' associated with the campaign.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contact-list", + ":contactListId", + "contacts" + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/contacts", + "variable": [ + { + "description": "Campaign ID to which the contact list belongs.", + "key": "campaignId", + "value": "" + }, + { + "description": "Contact List ID (as a number string).", + "key": "contactListId", + "value": "5" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"outcome\": \"Accepted\",\n \"statusCode\": \"\",\n \"summary\": \"\"\n}", + "code": 202, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Request accepted", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"contacts\": [\n {\n \"contactAttributes\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"contactAttributes\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contact-list", + ":contactListId", + "contacts" + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/contacts", + "variable": [ + { + "description": "Campaign ID to which the contact list belongs.", + "key": "campaignId" + }, + { + "description": "Contact List ID (as a number string).", + "key": "contactListId" + } + ] + } + }, + "status": "Accepted" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Invalid request", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"contacts\": [\n {\n \"contactAttributes\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"contactAttributes\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contact-list", + ":contactListId", + "contacts" + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/contacts", + "variable": [ + { + "description": "Campaign ID to which the contact list belongs.", + "key": "campaignId" + }, + { + "description": "Contact List ID (as a number string).", + "key": "contactListId" + } + ] + } + }, + "status": "Bad Request" + } + ] + }, + { + "name": "Update a contact's status within a contact list", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"contactStatus\": \"CLOSED\"\n}" + }, + "description": "Updates a contact's status within a contact list. After update, system overwrites 'Latest Telephony Outcome' to blank and 'Latest Business Outcome' to 'Closed via API call' if status is CLOSED. This is an Asynchronous operation.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contact-list", + ":contactListId", + "contacts", + ":contactId" + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/contacts/:contactId", + "variable": [ + { + "description": "Campaign ID.", + "key": "campaignId", + "value": "" + }, + { + "description": "Contact List ID (as a number string).", + "key": "contactListId", + "value": "5" + }, + { + "description": "Contact Unique ID (Contact Phone or Customer Unique ID or Account Unique ID)", + "key": "contactId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Invalid request", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"contactStatus\": \"CLOSED\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contact-list", + ":contactListId", + "contacts", + ":contactId" + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/contacts/:contactId", + "variable": [ + { + "description": "Campaign ID.", + "key": "campaignId" + }, + { + "description": "Contact List ID (as a number string).", + "key": "contactListId" + }, + { + "description": "Contact Unique ID (Contact Phone or Customer Unique ID or Account Unique ID)", + "key": "contactId" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"outcome\": \"Success\",\n \"statusCode\": \"\",\n \"summary\": \"\"\n}", + "code": 202, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Request queued", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"contactStatus\": \"CLOSED\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contact-list", + ":contactListId", + "contacts", + ":contactId" + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/contacts/:contactId", + "variable": [ + { + "description": "Campaign ID.", + "key": "campaignId" + }, + { + "description": "Contact List ID (as a number string).", + "key": "contactListId" + }, + { + "description": "Contact Unique ID (Contact Phone or Customer Unique ID or Account Unique ID)", + "key": "contactId" + } + ] + } + }, + "status": "Accepted" + } + ] + }, + { + "name": "Update contact list status", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"contactListStatus\": \"\"\n}" + }, + "description": "Updates the status of a contact list (e.g., EXPIRED). Note: This value is not case-sensitive.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contact-list", + ":contactListId", + "status" + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/status", + "variable": [ + { + "description": "Campaign ID.", + "key": "campaignId", + "value": "" + }, + { + "description": "Contact List ID (as a number string).", + "key": "contactListId", + "value": "5" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"outcome\": \"Success\",\n \"statusCode\": \"\",\n \"contactLists\": [\n {\n \"contactListId\": \"\",\n \"contactListStatus\": \"\",\n \"contactListRecordCount\": \"\",\n \"contactListSource\": \"\",\n \"dateOfCreation\": \"\",\n \"dateOfActivation\": \"\",\n \"dateOfExpiry\": \"\"\n },\n {\n \"contactListId\": \"\",\n \"contactListStatus\": \"\",\n \"contactListRecordCount\": \"\",\n \"contactListSource\": \"\",\n \"dateOfCreation\": \"\",\n \"dateOfActivation\": \"\",\n \"dateOfExpiry\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Contact list status updated successfully", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"contactListStatus\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contact-list", + ":contactListId", + "status" + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/status", + "variable": [ + { + "description": "Campaign ID.", + "key": "campaignId" + }, + { + "description": "Contact List ID (as a number string).", + "key": "contactListId" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Invalid request", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"contactListStatus\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contact-list", + ":contactListId", + "status" + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/status", + "variable": [ + { + "description": "Campaign ID.", + "key": "campaignId" + }, + { + "description": "Contact List ID (as a number string).", + "key": "contactListId" + } + ] + } + }, + "status": "Bad Request" + } + ] + }, + { + "name": "Get Contact Lists within a Campaign", + "request": { + "description": "Retrieves all contact lists within a campaign, with optional filters for status and source.\n\nThis is the **v3** endpoint. Each contact list entry includes `contactListRecordsProcessed` (total processed records). For dialer counts, source file name, and per-status contact counts, use the **v4** endpoint (`GET /v4/campaign-management/campaigns/{campaignId}/contact-lists`).\n\n**Caching:** Responses are cached for up to 30 seconds per campaign and filter combination.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contact-lists" + ], + "query": [ + { + "description": "Contact List Status filter (Active, Expired, UploadFailed, etc.)", + "key": "status", + "value": "Expired" + }, + { + "description": "Contact List Source filter (API, SFTP, ManualFile)", + "key": "source", + "value": "GlobalSFTP" + } + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-lists?status=Expired&source=GlobalSFTP", + "variable": [ + { + "description": "Campaign ID.", + "key": "campaignId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"outcome\": \"Failure\",\n \"statusCode\": \"\",\n \"contactLists\": [\n {\n \"contactListId\": \"\",\n \"contactListStatus\": \"\",\n \"contactListRecordProcessed\": \"\",\n \"contactListSource\": \"\",\n \"dateOfCreation\": \"\",\n \"dateOfActivation\": \"\",\n \"dateOfExpiry\": \"\"\n },\n {\n \"contactListId\": \"\",\n \"contactListStatus\": \"\",\n \"contactListRecordProcessed\": \"\",\n \"contactListSource\": \"\",\n \"dateOfCreation\": \"\",\n \"dateOfActivation\": \"\",\n \"dateOfExpiry\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Contact lists retrieved successfully", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contact-lists" + ], + "query": [ + { + "description": "Contact List Status filter (Active, Expired, UploadFailed, etc.)", + "key": "status", + "value": "Expired" + }, + { + "description": "Contact List Source filter (API, SFTP, ManualFile)", + "key": "source", + "value": "GlobalSFTP" + } + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-lists?status=Expired&source=GlobalSFTP", + "variable": [ + { + "description": "Campaign ID.", + "key": "campaignId" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Invalid request", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contact-lists" + ], + "query": [ + { + "description": "Contact List Status filter (Active, Expired, UploadFailed, etc.)", + "key": "status", + "value": "Expired" + }, + { + "description": "Contact List Source filter (API, SFTP, ManualFile)", + "key": "source", + "value": "GlobalSFTP" + } + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-lists?status=Expired&source=GlobalSFTP", + "variable": [ + { + "description": "Campaign ID.", + "key": "campaignId" + } + ] + } + }, + "status": "Bad Request" + } + ] + }, + { + "name": "Update contact status across the campaign chain", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"contactStatus\": \"CLOSED\",\n \"searchAcrossTheCampaignChain\": \"no\"\n}" + }, + "description": "Synchronously closes the specified contacts and returns the outcome in the same response. Contacts are identified using the same unique identifiers configured in your campaign field mappings, such as Contact Phone (format as per the associated field mapping) or Customer Unique ID or Account Unique ID (For more info, please refer to the [global variables help documentation](https://docs-campaign-for-contact-centers.webexcampaign.com/docs/global-variables)).\n\n By default, the API searches the specified campaign and any of its downstream target campaigns in the chain (across all active contact-lists associated with these campaigns), and closes the contact wherever it is found in a closeable state. Set `searchAcrossTheCampaignChain` to `no` to close the contact only in the campaign specified in the request path.\n\n**Optional query parameters**\n\n- `contactListId` - Search only the specific contact-list within the campaign specified in the request path. If `searchAcrossTheCampaignChain` is set to `yes` then all active contact-lists in the other downstream target campaigns in the chain are also searched.\n- `fields` - Return specified contact field values in the response for the matching contact records (for example: FirstName, LastName, AmountDue).", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contacts", + ":contactId" + ], + "query": [ + { + "description": "Optional. Search only the specific contact-list within the campaign specified in the request path. If `searchAcrossTheCampaignChain` is set to `yes`, then all active contact-lists in the other downstream target campaigns in the chain are also searched. When omitted, all active contact lists in that campaign are searched.", + "key": "contactListId", + "value": "7" + }, + { + "description": "Optional. Contact field names to include in the response (comma-separated names).", + "key": "fields", + "value": "" + } + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contacts/:contactId?contactListId=7&fields=", + "variable": [ + { + "description": "Campaign ID (as a string). All downstream target campaigns in the chain are included in the search.", + "key": "campaignId", + "value": "" + }, + { + "description": "Contact Unique ID (Contact Phone or Customer Unique ID or Account Unique ID)", + "key": "contactId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"outcome\": \"Success\",\n \"statusCode\": \"\",\n \"records\": [\n {\n \"updated\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"contactListId\": \"\",\n \"matchedBy\": {\n \"key_0\": \"\"\n },\n \"fields\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"comment\": \"\"\n },\n {\n \"updated\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"contactListId\": \"\",\n \"matchedBy\": {\n \"key_0\": \"\"\n },\n \"fields\": {\n \"key_0\": 3623,\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n \"comment\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Contact closed. See `outcome` and `records` for per-campaign details.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"contactStatus\": \"CLOSED\",\n \"searchAcrossTheCampaignChain\": \"no\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contacts", + ":contactId" + ], + "query": [ + { + "description": "Optional. Search only the specific contact-list within the campaign specified in the request path. If `searchAcrossTheCampaignChain` is set to `yes`, then all active contact-lists in the other downstream target campaigns in the chain are also searched. When omitted, all active contact lists in that campaign are searched.", + "key": "contactListId", + "value": "7" + }, + { + "description": "Optional. Contact field names to include in the response (comma-separated names).", + "key": "fields", + "value": "" + } + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contacts/:contactId?contactListId=7&fields=", + "variable": [ + { + "description": "Campaign ID (as a string). All downstream target campaigns in the chain are included in the search.", + "key": "campaignId", + "value": "" + }, + { + "description": "Contact Unique ID (Contact Phone or Customer Unique ID or Account Unique ID)", + "key": "contactId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Invalid request (for example, unsupported contactStatus, missing contactStatus, invalid contactListId, or malformed fields query parameter).", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"contactStatus\": \"CLOSED\",\n \"searchAcrossTheCampaignChain\": \"no\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contacts", + ":contactId" + ], + "query": [ + { + "description": "Optional. Search only the specific contact-list within the campaign specified in the request path. If `searchAcrossTheCampaignChain` is set to `yes`, then all active contact-lists in the other downstream target campaigns in the chain are also searched. When omitted, all active contact lists in that campaign are searched.", + "key": "contactListId", + "value": "7" + }, + { + "description": "Optional. Contact field names to include in the response (comma-separated names).", + "key": "fields", + "value": "" + } + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contacts/:contactId?contactListId=7&fields=", + "variable": [ + { + "description": "Campaign ID (as a string). All downstream target campaigns in the chain are included in the search.", + "key": "campaignId", + "value": "" + }, + { + "description": "Contact Unique ID (Contact Phone or Customer Unique ID or Account Unique ID)", + "key": "contactId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "This operation is not enabled for your organization.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"contactStatus\": \"CLOSED\",\n \"searchAcrossTheCampaignChain\": \"no\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contacts", + ":contactId" + ], + "query": [ + { + "description": "Optional. Search only the specific contact-list within the campaign specified in the request path. If `searchAcrossTheCampaignChain` is set to `yes`, then all active contact-lists in the other downstream target campaigns in the chain are also searched. When omitted, all active contact lists in that campaign are searched.", + "key": "contactListId", + "value": "7" + }, + { + "description": "Optional. Contact field names to include in the response (comma-separated names).", + "key": "fields", + "value": "" + } + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contacts/:contactId?contactListId=7&fields=", + "variable": [ + { + "description": "Campaign ID (as a string). All downstream target campaigns in the chain are included in the search.", + "key": "campaignId", + "value": "" + }, + { + "description": "Contact Unique ID (Contact Phone or Customer Unique ID or Account Unique ID)", + "key": "contactId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"outcome\": \"Success\",\n \"statusCode\": \"\",\n \"records\": [\n {\n \"updated\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"contactListId\": \"\",\n \"matchedBy\": {\n \"key_0\": \"\"\n },\n \"fields\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"comment\": \"\"\n },\n {\n \"updated\": \"\",\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"contactListId\": \"\",\n \"matchedBy\": {\n \"key_0\": \"\"\n },\n \"fields\": {\n \"key_0\": 3623,\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n \"comment\": \"\"\n }\n ]\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "No matching contact record found in any campaign in scope.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"contactStatus\": \"CLOSED\",\n \"searchAcrossTheCampaignChain\": \"no\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contacts", + ":contactId" + ], + "query": [ + { + "description": "Optional. Search only the specific contact-list within the campaign specified in the request path. If `searchAcrossTheCampaignChain` is set to `yes`, then all active contact-lists in the other downstream target campaigns in the chain are also searched. When omitted, all active contact lists in that campaign are searched.", + "key": "contactListId", + "value": "7" + }, + { + "description": "Optional. Contact field names to include in the response (comma-separated names).", + "key": "fields", + "value": "" + } + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contacts/:contactId?contactListId=7&fields=", + "variable": [ + { + "description": "Campaign ID (as a string). All downstream target campaigns in the chain are included in the search.", + "key": "campaignId", + "value": "" + }, + { + "description": "Contact Unique ID (Contact Phone or Customer Unique ID or Account Unique ID)", + "key": "contactId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Rate limit exceeded.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"contactStatus\": \"CLOSED\",\n \"searchAcrossTheCampaignChain\": \"no\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v3", + "campaign-management", + "campaigns", + ":campaignId", + "contacts", + ":contactId" + ], + "query": [ + { + "description": "Optional. Search only the specific contact-list within the campaign specified in the request path. If `searchAcrossTheCampaignChain` is set to `yes`, then all active contact-lists in the other downstream target campaigns in the chain are also searched. When omitted, all active contact lists in that campaign are searched.", + "key": "contactListId", + "value": "7" + }, + { + "description": "Optional. Contact field names to include in the response (comma-separated names).", + "key": "fields", + "value": "" + } + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contacts/:contactId?contactListId=7&fields=", + "variable": [ + { + "description": "Campaign ID (as a string). All downstream target campaigns in the chain are included in the search.", + "key": "campaignId", + "value": "" + }, + { + "description": "Contact Unique ID (Contact Phone or Customer Unique ID or Account Unique ID)", + "key": "contactId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "Get Contact Lists within a Campaign", + "request": { + "description": "Retrieves all contact lists within a campaign. Use the optional `status` and `source` query parameters to filter results.\n\nEach contact list in the response includes the source file name, the time contact counts were last updated, and a breakdown of contact counts by processing and dialer status (for example, processed, invalid, valid, eligible, fresh, open, closed, and ready for dialer).\n\nResponses may reflect the same data for up to 30 seconds when the same campaign and filters are requested repeatedly.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v4", + "campaign-management", + "campaigns", + ":campaignId", + "contact-lists" + ], + "query": [ + { + "description": "Contact List Status filter (Active, Expired, UploadFailed, etc.)", + "key": "status", + "value": "UploadFailed" + }, + { + "description": "Contact List Source filter (API, SFTP, ManualFile)", + "key": "source", + "value": "ManualFile" + } + ], + "raw": "{{baseUrl}}/v4/campaign-management/campaigns/:campaignId/contact-lists?status=UploadFailed&source=ManualFile", + "variable": [ + { + "description": "Campaign ID.", + "key": "campaignId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"outcome\": \"Failure\",\n \"statusCode\": \"\",\n \"contactLists\": [\n {\n \"contactListId\": \"\",\n \"contactListStatus\": \"\",\n \"contactListSource\": \"\",\n \"contactListSourceFileName\": \"\",\n \"contactListCountsTimestampUtc\": \"\",\n \"processedContactsCount\": \"\",\n \"invalidContactsCount\": \"\",\n \"validContactsCount\": \"\",\n \"eligibleContactsCount\": \"\",\n \"freshContactsCount\": \"\",\n \"openContactsCount\": \"\",\n \"closedContactsCount\": \"\",\n \"errorsContactsCount\": \"\",\n \"readyForDialerContactsCount\": \"\",\n \"sentToDialerAwaitingOutcomeContactsCount\": \"\",\n \"expiredContactsCount\": \"\",\n \"blockedContactsCount\": \"\",\n \"closedTransferredToChainedCampaignContactsCount\": \"\",\n \"dateOfCreation\": \"\",\n \"dateOfActivation\": \"\",\n \"dateOfExpiry\": \"\"\n },\n {\n \"contactListId\": \"\",\n \"contactListStatus\": \"\",\n \"contactListSource\": \"\",\n \"contactListSourceFileName\": \"\",\n \"contactListCountsTimestampUtc\": \"\",\n \"processedContactsCount\": \"\",\n \"invalidContactsCount\": \"\",\n \"validContactsCount\": \"\",\n \"eligibleContactsCount\": \"\",\n \"freshContactsCount\": \"\",\n \"openContactsCount\": \"\",\n \"closedContactsCount\": \"\",\n \"errorsContactsCount\": \"\",\n \"readyForDialerContactsCount\": \"\",\n \"sentToDialerAwaitingOutcomeContactsCount\": \"\",\n \"expiredContactsCount\": \"\",\n \"blockedContactsCount\": \"\",\n \"closedTransferredToChainedCampaignContactsCount\": \"\",\n \"dateOfCreation\": \"\",\n \"dateOfActivation\": \"\",\n \"dateOfExpiry\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Contact lists retrieved successfully", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v4", + "campaign-management", + "campaigns", + ":campaignId", + "contact-lists" + ], + "query": [ + { + "description": "Contact List Status filter (Active, Expired, UploadFailed, etc.)", + "key": "status", + "value": "UploadFailed" + }, + { + "description": "Contact List Source filter (API, SFTP, ManualFile)", + "key": "source", + "value": "ManualFile" + } + ], + "raw": "{{baseUrl}}/v4/campaign-management/campaigns/:campaignId/contact-lists?status=UploadFailed&source=ManualFile", + "variable": [ + { + "description": "Campaign ID.", + "key": "campaignId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Invalid request", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v4", + "campaign-management", + "campaigns", + ":campaignId", + "contact-lists" + ], + "query": [ + { + "description": "Contact List Status filter (Active, Expired, UploadFailed, etc.)", + "key": "status", + "value": "UploadFailed" + }, + { + "description": "Contact List Source filter (API, SFTP, ManualFile)", + "key": "source", + "value": "ManualFile" + } + ], + "raw": "{{baseUrl}}/v4/campaign-management/campaigns/:campaignId/contact-lists?status=UploadFailed&source=ManualFile", + "variable": [ + { + "description": "Campaign ID.", + "key": "campaignId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + } + ] + } + ], + "name": "Contact List Management" + }, + { + "item": [ + { + "name": "List summaries", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"orgId\": \"\",\n \"interactionId\": \"\",\n \"searchType\": \"AGENT\"\n}" + }, + "description": "Lists summaries based on the requested search type.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "summary", + "list" + ], + "raw": "{{baseUrl}}/summary/list" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized Operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"orgId\": \"\",\n \"interactionId\": \"\",\n \"searchType\": \"AGENT\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "summary", + "list" + ], + "raw": "{{baseUrl}}/summary/list" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Validation Error", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"orgId\": \"\",\n \"interactionId\": \"\",\n \"searchType\": \"AGENT\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "summary", + "list" + ], + "raw": "{{baseUrl}}/summary/list" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden Operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"orgId\": \"\",\n \"interactionId\": \"\",\n \"searchType\": \"AGENT\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "summary", + "list" + ], + "raw": "{{baseUrl}}/summary/list" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"orgId\": \"\",\n \"agentCiUserId\": \"\",\n \"interactionId\": \"\",\n \"queueId\": \"\",\n \"searchType\": \"AGENT\",\n \"summaries\": {\n \"key_0\": {\n \"key_0\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n },\n \"key_1\": {\n \"key_0\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"key_1\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n \"key_2\": {\n \"key_0\": {\n \"key_0\": \"\"\n }\n }\n }\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Successful operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"orgId\": \"\",\n \"interactionId\": \"\",\n \"searchType\": \"AGENT\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "summary", + "list" + ], + "raw": "{{baseUrl}}/summary/list" + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"orgId\": \"\",\n \"interactionId\": \"\",\n \"searchType\": \"AGENT\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "summary", + "list" + ], + "raw": "{{baseUrl}}/summary/list" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "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 \"orgId\": \"\",\n \"interactionId\": \"\",\n \"searchType\": \"AGENT\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "summary", + "list" + ], + "raw": "{{baseUrl}}/summary/list" + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "List summaries", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"orgId\": \"\",\n \"searchType\": \"INTERACTION\"\n}" + }, + "description": "Lists summaries based on the requested search type.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "generated-summaries", + "search" + ], + "raw": "{{baseUrl}}/generated-summaries/search" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized Operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"orgId\": \"\",\n \"searchType\": \"INTERACTION\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "generated-summaries", + "search" + ], + "raw": "{{baseUrl}}/generated-summaries/search" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"orgId\": \"\",\n \"searchType\": \"INTERACTION\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "generated-summaries", + "search" + ], + "raw": "{{baseUrl}}/generated-summaries/search" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "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 \"orgId\": \"\",\n \"searchType\": \"INTERACTION\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "generated-summaries", + "search" + ], + "raw": "{{baseUrl}}/generated-summaries/search" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden Operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"orgId\": \"\",\n \"searchType\": \"INTERACTION\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "generated-summaries", + "search" + ], + "raw": "{{baseUrl}}/generated-summaries/search" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"orgId\": \"\",\n \"agentCiUserId\": \"\",\n \"interactionId\": \"\",\n \"queueId\": \"\",\n \"searchType\": \"INTERACTION\",\n \"summaries\": {\n \"POST_CALL\": {\n \"key_0\": {\n \"initialContactReason\": \"\",\n \"additionalContext\": \"\",\n \"additionalContactReasons\": \"\",\n \"keyActionsTaken\": \"\",\n \"nextSteps\": \"\",\n \"chosenWrapUpCode\": \"\",\n \"proposedWrapUpCodes\": [\n {\n \"name\": \"\"\n },\n {\n \"name\": \"\"\n }\n ]\n },\n \"key_1\": {\n \"initialContactReason\": \"\",\n \"additionalContext\": \"\",\n \"additionalContactReasons\": \"\",\n \"keyActionsTaken\": \"\",\n \"nextSteps\": \"\",\n \"chosenWrapUpCode\": \"\",\n \"proposedWrapUpCodes\": [\n {\n \"name\": \"\"\n },\n {\n \"name\": \"\"\n }\n ]\n },\n \"key_2\": {\n \"initialContactReason\": \"\",\n \"additionalContext\": \"\",\n \"additionalContactReasons\": \"\",\n \"keyActionsTaken\": \"\",\n \"nextSteps\": \"\",\n \"chosenWrapUpCode\": \"\",\n \"proposedWrapUpCodes\": [\n {\n \"name\": \"\"\n },\n {\n \"name\": \"\"\n }\n ]\n },\n \"key_3\": {\n \"initialContactReason\": \"\",\n \"additionalContext\": \"\",\n \"additionalContactReasons\": \"\",\n \"keyActionsTaken\": \"\",\n \"nextSteps\": \"\",\n \"chosenWrapUpCode\": \"\",\n \"proposedWrapUpCodes\": [\n {\n \"name\": \"\"\n },\n {\n \"name\": \"\"\n }\n ]\n }\n },\n \"MID_CALL\": {\n \"key_0\": {\n \"reasonForTransferOrConsult\": \"\",\n \"additionalContext\": \"\",\n \"keyActionsTaken\": \"\"\n },\n \"key_1\": {\n \"reasonForTransferOrConsult\": \"\",\n \"additionalContext\": \"\",\n \"keyActionsTaken\": \"\"\n }\n }\n }\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Successful operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"orgId\": \"\",\n \"searchType\": \"INTERACTION\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "generated-summaries", + "search" + ], + "raw": "{{baseUrl}}/generated-summaries/search" + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Validation Error", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"orgId\": \"\",\n \"searchType\": \"INTERACTION\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "generated-summaries", + "search" + ], + "raw": "{{baseUrl}}/generated-summaries/search" + } + }, + "status": "Bad Request" + } + ] + } + ], + "name": "Agent Summaries" + }, + { + "description": "Operations for sending AI Assistant custom events for Webex Contact Center.", + "item": [ + { + "name": "Get suggestions", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"agentId\": \"\",\n \"orgId\": \"\",\n \"eventType\": \"CUSTOM_EVENT\",\n \"eventName\": \"GET_SUGGESTIONS\",\n \"eventDetails\": {\n \"data\": {\n \"interactionId\": \"\",\n \"actionTimeStamp\": \"\",\n \"trackingId\": \"\",\n \"languageCode\": \"\",\n \"aiAssistantSkillId\": \"\",\n \"source\": \"\"\n }\n }\n}" + }, + "description": "API for getting suggestions based on transcripts. \n\nNotes:\n- Requires machine account token with scope `cjp:config_read` for WxCC\n- Requires machine account token with scope `cjp-hybrid-conn:read` for WxCCE/CCE.\n- `aiAssistantSkillId` / `source` is required for WxCCE/CCE.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "event" + ], + "raw": "{{baseUrl}}/event" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "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 \"agentId\": \"\",\n \"orgId\": \"\",\n \"eventType\": \"CUSTOM_EVENT\",\n \"eventName\": \"GET_SUGGESTIONS\",\n \"eventDetails\": {\n \"data\": {\n \"interactionId\": \"\",\n \"actionTimeStamp\": \"\",\n \"trackingId\": \"\",\n \"languageCode\": \"\",\n \"aiAssistantSkillId\": \"\",\n \"source\": \"\"\n }\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "event" + ], + "raw": "{{baseUrl}}/event" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized Operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"agentId\": \"\",\n \"orgId\": \"\",\n \"eventType\": \"CUSTOM_EVENT\",\n \"eventName\": \"GET_SUGGESTIONS\",\n \"eventDetails\": {\n \"data\": {\n \"interactionId\": \"\",\n \"actionTimeStamp\": \"\",\n \"trackingId\": \"\",\n \"languageCode\": \"\",\n \"aiAssistantSkillId\": \"\",\n \"source\": \"\"\n }\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "event" + ], + "raw": "{{baseUrl}}/event" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Validation Error", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"agentId\": \"\",\n \"orgId\": \"\",\n \"eventType\": \"CUSTOM_EVENT\",\n \"eventName\": \"GET_SUGGESTIONS\",\n \"eventDetails\": {\n \"data\": {\n \"interactionId\": \"\",\n \"actionTimeStamp\": \"\",\n \"trackingId\": \"\",\n \"languageCode\": \"\",\n \"aiAssistantSkillId\": \"\",\n \"source\": \"\"\n }\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "event" + ], + "raw": "{{baseUrl}}/event" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden Operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"agentId\": \"\",\n \"orgId\": \"\",\n \"eventType\": \"CUSTOM_EVENT\",\n \"eventName\": \"GET_SUGGESTIONS\",\n \"eventDetails\": {\n \"data\": {\n \"interactionId\": \"\",\n \"actionTimeStamp\": \"\",\n \"trackingId\": \"\",\n \"languageCode\": \"\",\n \"aiAssistantSkillId\": \"\",\n \"source\": \"\"\n }\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "event" + ], + "raw": "{{baseUrl}}/event" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"agentId\": \"\",\n \"orgId\": \"\",\n \"eventType\": \"CUSTOM_EVENT\",\n \"eventName\": \"GET_SUGGESTIONS\",\n \"eventDetails\": {\n \"data\": {\n \"interactionId\": \"\",\n \"actionTimeStamp\": \"\",\n \"trackingId\": \"\",\n \"languageCode\": \"\",\n \"aiAssistantSkillId\": \"\",\n \"source\": \"\"\n }\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "event" + ], + "raw": "{{baseUrl}}/event" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 200, + "cookie": [], + "header": [], + "name": "Accepted", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"agentId\": \"\",\n \"orgId\": \"\",\n \"eventType\": \"CUSTOM_EVENT\",\n \"eventName\": \"GET_SUGGESTIONS\",\n \"eventDetails\": {\n \"data\": {\n \"interactionId\": \"\",\n \"actionTimeStamp\": \"\",\n \"trackingId\": \"\",\n \"languageCode\": \"\",\n \"aiAssistantSkillId\": \"\",\n \"source\": \"\"\n }\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "event" + ], + "raw": "{{baseUrl}}/event" + } + }, + "status": "OK" + } + ] + } + ], + "name": "AI Assistant" + }, + { + "item": [ + { + "name": "List Activity Definitions", + "request": { + "description": "List all available activity types with their full schemas, including inputs, outputs, ports, and descriptions. The response is sufficient on its own to construct nodes \u2014 there is no separate schema endpoint.\n\nScope: `cjp:config_read`", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities", + "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": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities", + "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": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities", + "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": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "[\n {\n \"activityName\": \"\",\n \"displayName\": \"\",\n \"category\": \"\",\n \"group\": \"\",\n \"activityType\": \"\",\n \"inputs\": [\n {\n \"description\": \"Default value applied when the input is not supplied. Type matches `type`.\",\n \"example\": null\n },\n {\n \"description\": \"Default value applied when the input is not supplied. Type matches `type`.\",\n \"example\": null\n }\n ],\n \"outputs\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"key_0\": \"string\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"outputPorts\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"key_0\": 5432.14093542425\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"activityName\": \"\",\n \"displayName\": \"\",\n \"category\": \"\",\n \"group\": \"\",\n \"activityType\": \"\",\n \"inputs\": [\n {\n \"description\": \"Default value applied when the input is not supplied. Type matches `type`.\",\n \"example\": null\n },\n {\n \"description\": \"Default value applied when the input is not supplied. Type matches `type`.\",\n \"example\": null\n }\n ],\n \"outputs\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"outputPorts\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"key_0\": true,\n \"key_1\": 7402,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n }\n]", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Array of activity definitions.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities", + "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": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + } + ] + }, + { + "name": "Describe an Activity", + "request": { + "description": "Retrieve a single activity's full definition, including inputs, outputs, named ports, and the JSON Schema for its inputs \u2014 all returned inline.\n\nScope: `cjp:config_read`", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities/:activityName", + "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": "" + }, + { + "description": "Activity type name (e.g., `play-message`, `queue-contact`).", + "key": "activityName", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities/:activityName", + "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": "" + }, + { + "description": "Activity type name (e.g., `play-message`, `queue-contact`).", + "key": "activityName", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities/:activityName", + "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": "" + }, + { + "description": "Activity type name (e.g., `play-message`, `queue-contact`).", + "key": "activityName", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities/:activityName", + "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": "" + }, + { + "description": "Activity type name (e.g., `play-message`, `queue-contact`).", + "key": "activityName", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"activityName\": \"\",\n \"displayName\": \"\",\n \"category\": \"\",\n \"group\": \"\",\n \"activityType\": \"\",\n \"inputs\": [\n {\n \"description\": \"Default value applied when the input is not supplied. Type matches `type`.\",\n \"example\": null\n },\n {\n \"description\": \"Default value applied when the input is not supplied. Type matches `type`.\",\n \"example\": null\n }\n ],\n \"outputs\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"key_0\": 9398.93577922434,\n \"key_1\": 1711,\n \"key_2\": false\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"outputPorts\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"key_0\": 8672\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Activity definition.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities/:activityName", + "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": "" + }, + { + "description": "Activity type name (e.g., `play-message`, `queue-contact`).", + "key": "activityName", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities/:activityName", + "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": "" + }, + { + "description": "Activity type name (e.g., `play-message`, `queue-contact`).", + "key": "activityName", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "Get Activity Input Choices", + "request": { + "description": "Resolve choices for an activity input. Use this when an activity input requires a value from a predefined or dynamically resolved set (e.g., available queues, audio files, agents).\n\nThis endpoint is only valid for inputs that expose choices (an input whose definition includes `allowedValues` or a `choicesEndpoint`, as returned by `describeActivity`). Calling it for an input that does not support choices returns 400.\n\n**Modes:**\n- `list` \u2014 Returns the full set of allowed values for a static-choice input.\n- `search` \u2014 Returns matches for the supplied `query` string. Use for type-ahead UIs over large choice sets.\n- `validate` \u2014 Checks whether a single `value` is allowed and returns its label/metadata if so.\n- `dynamic` \u2014 Resolves cascading choices whose allowed values depend on one or more sibling inputs. Pass the relevant sibling values via `parent_inputs` (e.g., a queue list scoped to a previously selected team).\n\nScope: `cjp:config_read`", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName", + "inputs", + ":inputName", + "choices" + ], + "query": [ + { + "description": "Resolution mode. Defaults to `list`.", + "key": "mode", + "value": "list" + }, + { + "description": "Search term. Required when `mode=search`.", + "key": "query", + "value": "" + }, + { + "description": "Candidate value to validate. Required when `mode=validate`.", + "key": "value", + "value": "" + }, + { + "description": "JSON object of parent input values used for cascading resolution. Required when `mode=dynamic`.", + "key": "parent_inputs", + "value": "" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities/:activityName/inputs/:inputName/choices?mode=list&query=&value=&parent_inputs=", + "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": "" + }, + { + "description": "Activity type name.", + "key": "activityName", + "value": "" + }, + { + "description": "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).", + "key": "inputName", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName", + "inputs", + ":inputName", + "choices" + ], + "query": [ + { + "description": "Resolution mode. Defaults to `list`.", + "key": "mode", + "value": "list" + }, + { + "description": "Search term. Required when `mode=search`.", + "key": "query", + "value": "" + }, + { + "description": "Candidate value to validate. Required when `mode=validate`.", + "key": "value", + "value": "" + }, + { + "description": "JSON object of parent input values used for cascading resolution. Required when `mode=dynamic`.", + "key": "parent_inputs", + "value": "" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities/:activityName/inputs/:inputName/choices?mode=list&query=&value=&parent_inputs=", + "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": "" + }, + { + "description": "Activity type name.", + "key": "activityName", + "value": "" + }, + { + "description": "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).", + "key": "inputName", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "[\n {\n \"value\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": false\n },\n {\n \"value\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"key_0\": 2389.9442230242385,\n \"key_1\": 6410\n }\n]", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Array of allowed values with labels and descriptions.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName", + "inputs", + ":inputName", + "choices" + ], + "query": [ + { + "description": "Resolution mode. Defaults to `list`.", + "key": "mode", + "value": "list" + }, + { + "description": "Search term. Required when `mode=search`.", + "key": "query", + "value": "" + }, + { + "description": "Candidate value to validate. Required when `mode=validate`.", + "key": "value", + "value": "" + }, + { + "description": "JSON object of parent input values used for cascading resolution. Required when `mode=dynamic`.", + "key": "parent_inputs", + "value": "" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities/:activityName/inputs/:inputName/choices?mode=list&query=&value=&parent_inputs=", + "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": "" + }, + { + "description": "Activity type name.", + "key": "activityName", + "value": "" + }, + { + "description": "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).", + "key": "inputName", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName", + "inputs", + ":inputName", + "choices" + ], + "query": [ + { + "description": "Resolution mode. Defaults to `list`.", + "key": "mode", + "value": "list" + }, + { + "description": "Search term. Required when `mode=search`.", + "key": "query", + "value": "" + }, + { + "description": "Candidate value to validate. Required when `mode=validate`.", + "key": "value", + "value": "" + }, + { + "description": "JSON object of parent input values used for cascading resolution. Required when `mode=dynamic`.", + "key": "parent_inputs", + "value": "" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities/:activityName/inputs/:inputName/choices?mode=list&query=&value=&parent_inputs=", + "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": "" + }, + { + "description": "Activity type name.", + "key": "activityName", + "value": "" + }, + { + "description": "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).", + "key": "inputName", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName", + "inputs", + ":inputName", + "choices" + ], + "query": [ + { + "description": "Resolution mode. Defaults to `list`.", + "key": "mode", + "value": "list" + }, + { + "description": "Search term. Required when `mode=search`.", + "key": "query", + "value": "" + }, + { + "description": "Candidate value to validate. Required when `mode=validate`.", + "key": "value", + "value": "" + }, + { + "description": "JSON object of parent input values used for cascading resolution. Required when `mode=dynamic`.", + "key": "parent_inputs", + "value": "" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities/:activityName/inputs/:inputName/choices?mode=list&query=&value=&parent_inputs=", + "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": "" + }, + { + "description": "Activity type name.", + "key": "activityName", + "value": "" + }, + { + "description": "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).", + "key": "inputName", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName", + "inputs", + ":inputName", + "choices" + ], + "query": [ + { + "description": "Resolution mode. Defaults to `list`.", + "key": "mode", + "value": "list" + }, + { + "description": "Search term. Required when `mode=search`.", + "key": "query", + "value": "" + }, + { + "description": "Candidate value to validate. Required when `mode=validate`.", + "key": "value", + "value": "" + }, + { + "description": "JSON object of parent input values used for cascading resolution. Required when `mode=dynamic`.", + "key": "parent_inputs", + "value": "" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities/:activityName/inputs/:inputName/choices?mode=list&query=&value=&parent_inputs=", + "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": "" + }, + { + "description": "Activity type name.", + "key": "activityName", + "value": "" + }, + { + "description": "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).", + "key": "inputName", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"key_0\": 9060.03176494062\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request \u2014 missing or invalid mode-specific parameter.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName", + "inputs", + ":inputName", + "choices" + ], + "query": [ + { + "description": "Resolution mode. Defaults to `list`.", + "key": "mode", + "value": "list" + }, + { + "description": "Search term. Required when `mode=search`.", + "key": "query", + "value": "" + }, + { + "description": "Candidate value to validate. Required when `mode=validate`.", + "key": "value", + "value": "" + }, + { + "description": "JSON object of parent input values used for cascading resolution. Required when `mode=dynamic`.", + "key": "parent_inputs", + "value": "" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/activities/:activityName/inputs/:inputName/choices?mode=list&query=&value=&parent_inputs=", + "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": "" + }, + { + "description": "Activity type name.", + "key": "activityName", + "value": "" + }, + { + "description": "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).", + "key": "inputName", + "value": "" + } + ] + } + }, + "status": "Bad Request" + } + ] + }, + { + "name": "List Activity Definitions", + "request": { + "description": "List all available activity types with their full schemas, including inputs, outputs, ports, and descriptions. The response is sufficient on its own to construct nodes \u2014 there is no separate schema endpoint.\n\nScope: `cjp:config_read`", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities", + "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": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities", + "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": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "[\n {\n \"activityName\": \"\",\n \"displayName\": \"\",\n \"category\": \"\",\n \"group\": \"\",\n \"activityType\": \"\",\n \"inputs\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\",\n \"showOnCondition\": \"\",\n \"isSecure\": \"\",\n \"allowedValues\": [\n \"\",\n \"\"\n ],\n \"choicesEndpoint\": \"\",\n \"children\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\",\n \"showOnCondition\": \"\",\n \"isSecure\": \"\",\n \"allowedValues\": [\n \"\",\n \"\"\n ],\n \"choicesEndpoint\": \"\",\n \"children\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"description\": \"\"\n }\n ],\n \"outputs\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"key_0\": false,\n \"key_1\": true\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"outputPorts\": [\n {\n \"condition\": \"\",\n \"label\": \"\",\n \"isErrorPath\": \"\",\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n {\n \"condition\": \"\",\n \"label\": \"\",\n \"isErrorPath\": \"\"\n }\n ],\n \"key_0\": 9616,\n \"key_1\": 3566,\n \"key_2\": true\n },\n {\n \"activityName\": \"\",\n \"displayName\": \"\",\n \"category\": \"\",\n \"group\": \"\",\n \"activityType\": \"\",\n \"inputs\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\",\n \"showOnCondition\": \"\",\n \"isSecure\": \"\",\n \"allowedValues\": [\n \"\",\n \"\"\n ],\n \"choicesEndpoint\": \"\",\n \"children\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\",\n \"showOnCondition\": \"\",\n \"isSecure\": \"\",\n \"allowedValues\": [\n \"\",\n \"\"\n ],\n \"choicesEndpoint\": \"\",\n \"children\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"description\": \"\"\n }\n ],\n \"outputs\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"key_0\": \"string\"\n }\n ],\n \"outputPorts\": [\n {\n \"condition\": \"\",\n \"label\": \"\",\n \"isErrorPath\": \"\",\n \"key_0\": 2690.99305683141,\n \"key_1\": \"string\"\n },\n {\n \"condition\": \"\",\n \"label\": \"\",\n \"isErrorPath\": \"\",\n \"key_0\": 795.6686955506486\n }\n ]\n }\n]", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Array of activity definitions.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities", + "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": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities", + "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": "" + } + ] + } + }, + "status": "Forbidden" + } + ] + }, + { + "name": "Describe an Activity", + "request": { + "description": "Retrieve a single activity's full definition, including inputs, outputs, named ports, and the JSON Schema for its inputs \u2014 all returned inline.\n\nScope: `cjp:config_read`", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities/:activityName", + "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": "" + }, + { + "description": "Activity type name (e.g., `play-message`, `queue-contact`).", + "key": "activityName", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"activityName\": \"\",\n \"displayName\": \"\",\n \"category\": \"\",\n \"group\": \"\",\n \"activityType\": \"\",\n \"inputs\": [\n {\n \"description\": \"Default value applied when the input is not supplied. Type matches `type`.\",\n \"example\": null\n },\n {\n \"description\": \"Default value applied when the input is not supplied. Type matches `type`.\",\n \"example\": null\n }\n ],\n \"outputs\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"key_0\": \"string\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"key_0\": true,\n \"key_1\": 8800.919211330112,\n \"key_2\": false,\n \"key_3\": 9039.531040592843\n }\n ],\n \"outputPorts\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Activity definition.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities/:activityName", + "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": "" + }, + { + "description": "Activity type name (e.g., `play-message`, `queue-contact`).", + "key": "activityName", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities/:activityName", + "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": "" + }, + { + "description": "Activity type name (e.g., `play-message`, `queue-contact`).", + "key": "activityName", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities/:activityName", + "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": "" + }, + { + "description": "Activity type name (e.g., `play-message`, `queue-contact`).", + "key": "activityName", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities/:activityName", + "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": "" + }, + { + "description": "Activity type name (e.g., `play-message`, `queue-contact`).", + "key": "activityName", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities/:activityName", + "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": "" + }, + { + "description": "Activity type name (e.g., `play-message`, `queue-contact`).", + "key": "activityName", + "value": "" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Get Activity Input Choices", + "request": { + "description": "Resolve choices for an activity input. Use this when an activity input requires a value from a predefined or dynamically resolved set (e.g., available queues, audio files, agents).\n\nThis endpoint is only valid for inputs that expose choices (an input whose definition includes `allowedValues` or a `choicesEndpoint`, as returned by `describeActivity`). Calling it for an input that does not support choices returns 400.\n\nPass `search` to filter the choices (type-ahead). Add `validate=true` together with `search` to do a point-lookup of a single value instead of filtering \u2014 the match is against the choice's `value` (its ID), not its display `name`. For a cascading input whose allowed values depend on a sibling input, supply the parent with `parentInputName` and `parentValue`; otherwise a cascading input returns 400.\n\nFiltering and validation apply only to dynamic (`choicesEndpoint`-backed) inputs. A static input always returns its full enumerated list regardless of `search`/`validate`.\n\nScope: `cjp:config_read`", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName", + "inputs", + ":inputName", + "choices" + ], + "query": [ + { + "description": "Search text used to filter the returned choices (type-ahead). When `validate=true`, this is instead the single value to look up.", + "key": "search", + "value": "" + }, + { + "description": "When `true` and `search` is supplied, performs a point-lookup of the single value in `search` (matched against the choice's `value`/ID) instead of filtering.", + "key": "validate", + "value": "false" + }, + { + "description": "Parent input value for a cascading/dynamic input (for example, the selected `channelType`).", + "key": "parentValue", + "value": "" + }, + { + "description": "Parent input name for a cascading/dynamic input. Required when `parentValue` is provided.", + "key": "parentInputName", + "value": "" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities/:activityName/inputs/:inputName/choices?search=&validate=false&parentValue=&parentInputName=", + "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": "" + }, + { + "description": "Activity type name.", + "key": "activityName", + "value": "" + }, + { + "description": "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).", + "key": "inputName", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName", + "inputs", + ":inputName", + "choices" + ], + "query": [ + { + "description": "Search text used to filter the returned choices (type-ahead). When `validate=true`, this is instead the single value to look up.", + "key": "search", + "value": "" + }, + { + "description": "When `true` and `search` is supplied, performs a point-lookup of the single value in `search` (matched against the choice's `value`/ID) instead of filtering.", + "key": "validate", + "value": "false" + }, + { + "description": "Parent input value for a cascading/dynamic input (for example, the selected `channelType`).", + "key": "parentValue", + "value": "" + }, + { + "description": "Parent input name for a cascading/dynamic input. Required when `parentValue` is provided.", + "key": "parentInputName", + "value": "" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities/:activityName/inputs/:inputName/choices?search=&validate=false&parentValue=&parentInputName=", + "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": "" + }, + { + "description": "Activity type name.", + "key": "activityName", + "value": "" + }, + { + "description": "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).", + "key": "inputName", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName", + "inputs", + ":inputName", + "choices" + ], + "query": [ + { + "description": "Search text used to filter the returned choices (type-ahead). When `validate=true`, this is instead the single value to look up.", + "key": "search", + "value": "" + }, + { + "description": "When `true` and `search` is supplied, performs a point-lookup of the single value in `search` (matched against the choice's `value`/ID) instead of filtering.", + "key": "validate", + "value": "false" + }, + { + "description": "Parent input value for a cascading/dynamic input (for example, the selected `channelType`).", + "key": "parentValue", + "value": "" + }, + { + "description": "Parent input name for a cascading/dynamic input. Required when `parentValue` is provided.", + "key": "parentInputName", + "value": "" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities/:activityName/inputs/:inputName/choices?search=&validate=false&parentValue=&parentInputName=", + "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": "" + }, + { + "description": "Activity type name.", + "key": "activityName", + "value": "" + }, + { + "description": "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).", + "key": "inputName", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"count\": \"\",\n \"source\": \"search\",\n \"choices\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"key_0\": 8072\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"key_0\": 1659.0658763020572,\n \"key_1\": true,\n \"key_2\": true\n }\n ],\n \"parentInputName\": \"\",\n \"parentValue\": \"\",\n \"isSearchEnabled\": \"\",\n \"resolvedInput\": \"\",\n \"activity\": \"\",\n \"input\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resolved choices for the input, plus resolution metadata.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName", + "inputs", + ":inputName", + "choices" + ], + "query": [ + { + "description": "Search text used to filter the returned choices (type-ahead). When `validate=true`, this is instead the single value to look up.", + "key": "search", + "value": "" + }, + { + "description": "When `true` and `search` is supplied, performs a point-lookup of the single value in `search` (matched against the choice's `value`/ID) instead of filtering.", + "key": "validate", + "value": "false" + }, + { + "description": "Parent input value for a cascading/dynamic input (for example, the selected `channelType`).", + "key": "parentValue", + "value": "" + }, + { + "description": "Parent input name for a cascading/dynamic input. Required when `parentValue` is provided.", + "key": "parentInputName", + "value": "" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities/:activityName/inputs/:inputName/choices?search=&validate=false&parentValue=&parentInputName=", + "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": "" + }, + { + "description": "Activity type name.", + "key": "activityName", + "value": "" + }, + { + "description": "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).", + "key": "inputName", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName", + "inputs", + ":inputName", + "choices" + ], + "query": [ + { + "description": "Search text used to filter the returned choices (type-ahead). When `validate=true`, this is instead the single value to look up.", + "key": "search", + "value": "" + }, + { + "description": "When `true` and `search` is supplied, performs a point-lookup of the single value in `search` (matched against the choice's `value`/ID) instead of filtering.", + "key": "validate", + "value": "false" + }, + { + "description": "Parent input value for a cascading/dynamic input (for example, the selected `channelType`).", + "key": "parentValue", + "value": "" + }, + { + "description": "Parent input name for a cascading/dynamic input. Required when `parentValue` is provided.", + "key": "parentInputName", + "value": "" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities/:activityName/inputs/:inputName/choices?search=&validate=false&parentValue=&parentInputName=", + "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": "" + }, + { + "description": "Activity type name.", + "key": "activityName", + "value": "" + }, + { + "description": "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).", + "key": "inputName", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request \u2014 a cascading input was queried without its parent (`parentInputName`/`parentValue`), or the input does not support choices.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName", + "inputs", + ":inputName", + "choices" + ], + "query": [ + { + "description": "Search text used to filter the returned choices (type-ahead). When `validate=true`, this is instead the single value to look up.", + "key": "search", + "value": "" + }, + { + "description": "When `true` and `search` is supplied, performs a point-lookup of the single value in `search` (matched against the choice's `value`/ID) instead of filtering.", + "key": "validate", + "value": "false" + }, + { + "description": "Parent input value for a cascading/dynamic input (for example, the selected `channelType`).", + "key": "parentValue", + "value": "" + }, + { + "description": "Parent input name for a cascading/dynamic input. Required when `parentValue` is provided.", + "key": "parentInputName", + "value": "" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities/:activityName/inputs/:inputName/choices?search=&validate=false&parentValue=&parentInputName=", + "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": "" + }, + { + "description": "Activity type name.", + "key": "activityName", + "value": "" + }, + { + "description": "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).", + "key": "inputName", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "activities", + ":activityName", + "inputs", + ":inputName", + "choices" + ], + "query": [ + { + "description": "Search text used to filter the returned choices (type-ahead). When `validate=true`, this is instead the single value to look up.", + "key": "search", + "value": "" + }, + { + "description": "When `true` and `search` is supplied, performs a point-lookup of the single value in `search` (matched against the choice's `value`/ID) instead of filtering.", + "key": "validate", + "value": "false" + }, + { + "description": "Parent input value for a cascading/dynamic input (for example, the selected `channelType`).", + "key": "parentValue", + "value": "" + }, + { + "description": "Parent input name for a cascading/dynamic input. Required when `parentValue` is provided.", + "key": "parentInputName", + "value": "" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/activities/:activityName/inputs/:inputName/choices?search=&validate=false&parentValue=&parentInputName=", + "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": "" + }, + { + "description": "Activity type name.", + "key": "activityName", + "value": "" + }, + { + "description": "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).", + "key": "inputName", + "value": "" + } + ] + } + }, + "status": "Forbidden" + } + ] + } + ], + "name": "Activities" + }, + { + "item": [ + { + "name": "List Event Specifications", + "request": { + "description": "List the event types available for use in `event_flows[]`. Each entry describes the event name, payload schema, and any contextual metadata bound when the event fires.\n\nScope: `cjp:config_read`", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "event-specifications" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/event-specifications", + "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 {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"payloadSchema\": {\n \"key_0\": false,\n \"key_1\": false\n },\n \"context\": {\n \"key_0\": 7741,\n \"key_1\": false,\n \"key_2\": 2476.351587737975\n }\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"payloadSchema\": {\n \"key_0\": false\n },\n \"context\": {\n \"key_0\": 3405,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n }\n]", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Array of event specifications.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "event-specifications" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/event-specifications", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "event-specifications" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/event-specifications", + "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": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "event-specifications" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/event-specifications", + "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": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "event-specifications" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/event-specifications", + "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": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "event-specifications" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/event-specifications", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + } + ] + }, + { + "name": "List Event Specifications", + "request": { + "description": "List the event types available for use in `event_flows[]`. Each entry describes the event name, payload schema, and any contextual metadata bound when the event fires.\n\nScope: `cjp:config_read`", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "event-specifications" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/event-specifications", + "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, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "event-specifications" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/event-specifications", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "event-specifications" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/event-specifications", + "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": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "event-specifications" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/event-specifications", + "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": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"specifications\": [\n {\n \"eventSpecificationName\": \"\",\n \"eventSourceName\": \"\",\n \"eventClassificationName\": \"\",\n \"key_0\": \"string\",\n \"key_1\": 8785.675897296518,\n \"key_2\": 6906\n },\n {\n \"eventSpecificationName\": \"\",\n \"eventSourceName\": \"\",\n \"eventClassificationName\": \"\"\n }\n ],\n \"quick_start\": {\n \"key_0\": false,\n \"key_1\": true\n },\n \"key_0\": 5174,\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": 1874.8111871908945,\n \"key_4\": false\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Available event specifications, plus ready-to-paste quick-start snippets.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "event-specifications" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/event-specifications", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "event-specifications" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/event-specifications", + "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": "" + } + ] + } + }, + "status": "Forbidden" + } + ] + } + ], + "name": "Events" + }, + { + "item": [ + { + "name": "List Flows or Subflows", + "request": { + "description": "Returns a list of flows in response. Channel-based filtering can be applied with the `searchBy` query parameter (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`). Channel visibility may be constrained by organization feature flags.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + }, + { + "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": "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": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "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": "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).", + "key": "searchBy", + "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": "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" + }, + { + "description": "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&ids=&page=0&partialNameSearch=&searchBy=&size=10&includePagination=false&isValidation=false", + "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": 400, + "cookie": [], + "header": [], + "name": "Bad request", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + }, + { + "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": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "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": "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).", + "key": "searchBy", + "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": "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" + }, + { + "description": "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&searchBy=&size=10&includePagination=false&isValidation=false", + "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": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "[\n {\n \"associatedChannels\": [\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\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 {\n \"associatedChannels\": [\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\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": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + }, + { + "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": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "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": "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).", + "key": "searchBy", + "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": "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" + }, + { + "description": "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&searchBy=&size=10&includePagination=false&isValidation=false", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + }, + { + "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": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "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": "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).", + "key": "searchBy", + "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": "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" + }, + { + "description": "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&searchBy=&size=10&includePagination=false&isValidation=false", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + }, + { + "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": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "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": "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).", + "key": "searchBy", + "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": "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" + }, + { + "description": "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&searchBy=&size=10&includePagination=false&isValidation=false", + "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": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + }, + { + "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": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "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": "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).", + "key": "searchBy", + "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": "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" + }, + { + "description": "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&searchBy=&size=10&includePagination=false&isValidation=false", + "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": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + }, + { + "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": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "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": "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).", + "key": "searchBy", + "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": "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" + }, + { + "description": "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&searchBy=&size=10&includePagination=false&isValidation=false", + "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": "" + } + ] + } + }, + "status": "Internal Server Error" + } + ] + }, + { + "name": "Publish a Flow or Subflow", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" + ], + "query": [ + { + "description": "If true, the flow's pre-publish validation is skipped. Use with care.", + "key": "skipValidation", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish?skipValidation=false&flowType=FLOW", + "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 \"associatedChannels\": [\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"assignedRS\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"draftVersion\": {\n \"associatedChannels\": [\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\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 }\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 },\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 \"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 },\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 },\n \"flowType\": \"\",\n \"flowVersions\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"latestVersion\": {\n \"associatedChannels\": [\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\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 }\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 \"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 },\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 \"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": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" + ], + "query": [ + { + "description": "If true, the flow's pre-publish validation is skipped. Use with care.", + "key": "skipValidation", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish?skipValidation=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" + ], + "query": [ + { + "description": "If true, the flow's pre-publish validation is skipped. Use with care.", + "key": "skipValidation", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish?skipValidation=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad request", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" + ], + "query": [ + { + "description": "If true, the flow's pre-publish validation is skipped. Use with care.", + "key": "skipValidation", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish?skipValidation=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" + ], + "query": [ + { + "description": "If true, the flow's pre-publish validation is skipped. Use with care.", + "key": "skipValidation", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish?skipValidation=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_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 \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" + ], + "query": [ + { + "description": "If true, the flow's pre-publish validation is skipped. Use with care.", + "key": "skipValidation", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish?skipValidation=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 201, + "cookie": [], + "header": [], + "name": "Created", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" + ], + "query": [ + { + "description": "If true, the flow's pre-publish validation is skipped. Use with care.", + "key": "skipValidation", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish?skipValidation=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Created" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" + ], + "query": [ + { + "description": "If true, the flow's pre-publish validation is skipped. Use with care.", + "key": "skipValidation", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish?skipValidation=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Forbidden" + } + ] + }, + { + "name": "Lock a Flow or Subflow", + "request": { + "description": "Lock a flow to prevent concurrent edits by other users. Locks expire after 15 minutes of inactivity.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:lock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:lock?flowType=FLOW", + "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": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:lock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:lock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict \u2014 the flow is already locked by another user.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:lock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:lock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:lock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:lock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:lock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:lock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"flowId\": \"\",\n \"lockedBy\": \"\",\n \"lockedAt\": \"\",\n \"expiresAt\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Lock confirmation with expiry information.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:lock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:lock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:lock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:lock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "Unlock a Flow or Subflow", + "request": { + "description": "Release the lock on a flow to allow other users to edit it.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:unlock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:unlock?flowType=FLOW", + "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": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:unlock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:unlock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:unlock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:unlock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:unlock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:unlock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"flowId\": \"\",\n \"lockedBy\": \"\",\n \"lockedAt\": \"\",\n \"expiresAt\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unlock confirmation.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:unlock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:unlock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:unlock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:unlock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Validate a Flow", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "description": "Dry-run validate a flow definition without persisting it. Use this to check correctness before importing.\n\nNote: validation is more lenient than import. A flow that passes `:validate` can still be rejected by `:import` (for example, a missing start activity), so a successful validation does not guarantee a successful import.\n\nScope: `cjp:config_write`", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows:validate" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows:validate", + "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, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows:validate" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows:validate", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"valid\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Validation result.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows:validate" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows:validate", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows:validate" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows:validate", + "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": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows:validate" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows:validate", + "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": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows:validate" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows:validate", + "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": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"key_0\": 9060.03176494062\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request \u2014 Invalid flow schema or missing required fields.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows:validate" + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows:validate", + "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": "" + } + ] + } + }, + "status": "Bad Request" + } + ] + }, + { + "name": "Import a Flow", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "description": "Import a new flow from a flow definition. Creates the flow in draft state and returns the assigned flow metadata, including `flowId`.\n\nScope: `cjp:config_write`", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"key_0\": 9060.03176494062\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Conflict \u2014 a flow with the same name already exists and `overwrite` is false.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"valid\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", + "code": 422, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unprocessable Entity \u2014 flow document failed validation.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"key_0\": 9060.03176494062\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"flow\": {\n \"id\": \"\",\n \"orgId\": \"\",\n \"version\": \"\",\n \"flowType\": \"FLOW\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"Draft\",\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\"\n },\n \"preflightWarnings\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": 6078,\n \"key_1\": 5281.393863663399\n }\n ],\n \"preflightWarningsCount\": \"\"\n}", + "code": 201, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Created \u2014 flow metadata including the assigned `flowId`.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Created" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Get a Flow", + "request": { + "description": "Retrieve the current draft of a flow as a flow document. To fetch a specific published version, use the `:export` endpoint.\n\nScope: `cjp:config_read`", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Flow JSON document.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + } + ] + }, + { + "name": "Save a Flow Draft", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "description": "Save a complete flow document as the current draft, replacing the existing draft. Pass `expectedVersion` as a query parameter to enable optimistic locking; the request fails with `409 Conflict` if the server-side version does not match. Omit `expectedVersion` to skip the check.\n\nScope: `cjp:config_write`", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"valid\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", + "code": 422, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unprocessable Entity \u2014 flow document failed validation.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"flow\": {\n \"id\": \"\",\n \"orgId\": \"\",\n \"version\": \"\",\n \"flowType\": \"FLOW\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"Draft\",\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\"\n },\n \"preflightWarnings\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": 6078,\n \"key_1\": 5281.393863663399\n }\n ],\n \"preflightWarningsCount\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Updated flow metadata, including the new `version`.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"key_0\": 9060.03176494062\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict \u2014 `expectedVersion` does not match the current draft version.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Conflict" + } + ] + }, + { + "name": "Patch a Flow Draft", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 9003,\n \"key_1\": true\n },\n {\n \"key_0\": 4320.006789081803\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 4145.897223830717\n },\n {\n \"key_0\": 4761.968016218918,\n \"key_1\": \"string\",\n \"key_2\": 486\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "description": "Apply partial updates to an existing flow draft without replacing the entire document. The patch body is a Patch Draft Contract \u2014 server-side merge, idempotent, and re-validated after the merge. The patch is rejected if the merged document fails validation, so the draft is never left in a broken state. The body may also include top-level overrides such as `name` and `description`.\n\nPass `expectedVersion` as a query parameter to enable optimistic locking; the request fails with `409 Conflict` if the server-side version does not match. Omit `expectedVersion` to skip the check.\n\nScope: `cjp:config_write`", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 9003,\n \"key_1\": true\n },\n {\n \"key_0\": 4320.006789081803\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 4145.897223830717\n },\n {\n \"key_0\": 4761.968016218918,\n \"key_1\": \"string\",\n \"key_2\": 486\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict \u2014 `expectedVersion` does not match the current draft version.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 9003,\n \"key_1\": true\n },\n {\n \"key_0\": 4320.006789081803\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 4145.897223830717\n },\n {\n \"key_0\": 4761.968016218918,\n \"key_1\": \"string\",\n \"key_2\": 486\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"valid\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", + "code": 422, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unprocessable Entity \u2014 merged flow document failed validation.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 9003,\n \"key_1\": true\n },\n {\n \"key_0\": 4320.006789081803\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 4145.897223830717\n },\n {\n \"key_0\": 4761.968016218918,\n \"key_1\": \"string\",\n \"key_2\": 486\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"flow\": {\n \"id\": \"\",\n \"orgId\": \"\",\n \"version\": \"\",\n \"flowType\": \"FLOW\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"Draft\",\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\"\n },\n \"preflightWarnings\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": 6078,\n \"key_1\": 5281.393863663399\n }\n ],\n \"preflightWarningsCount\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Updated flow metadata, including the new `version`.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 9003,\n \"key_1\": true\n },\n {\n \"key_0\": 4320.006789081803\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 4145.897223830717\n },\n {\n \"key_0\": 4761.968016218918,\n \"key_1\": \"string\",\n \"key_2\": 486\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"key_0\": 9060.03176494062\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 9003,\n \"key_1\": true\n },\n {\n \"key_0\": 4320.006789081803\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 4145.897223830717\n },\n {\n \"key_0\": 4761.968016218918,\n \"key_1\": \"string\",\n \"key_2\": 486\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 9003,\n \"key_1\": true\n },\n {\n \"key_0\": 4320.006789081803\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 4145.897223830717\n },\n {\n \"key_0\": 4761.968016218918,\n \"key_1\": \"string\",\n \"key_2\": 486\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 9003,\n \"key_1\": true\n },\n {\n \"key_0\": 4320.006789081803\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 4145.897223830717\n },\n {\n \"key_0\": 4761.968016218918,\n \"key_1\": \"string\",\n \"key_2\": 486\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 9003,\n \"key_1\": true\n },\n {\n \"key_0\": 4320.006789081803\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 4145.897223830717\n },\n {\n \"key_0\": 4761.968016218918,\n \"key_1\": \"string\",\n \"key_2\": 486\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Validate an Existing Flow Draft", + "request": { + "description": "Validate the current draft of an existing flow (read-only operation).\n\nScope: `cjp:config_read`", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:validate" + ], + "query": [ + { + "description": "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.", + "key": "versionId", + "value": "draft" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/{{flowId}}:validate?versionId=draft&flowType=FLOW", + "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": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:validate" + ], + "query": [ + { + "description": "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.", + "key": "versionId", + "value": "draft" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/{{flowId}}:validate?versionId=draft&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:validate" + ], + "query": [ + { + "description": "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.", + "key": "versionId", + "value": "draft" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/{{flowId}}:validate?versionId=draft&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:validate" + ], + "query": [ + { + "description": "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.", + "key": "versionId", + "value": "draft" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/{{flowId}}:validate?versionId=draft&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:validate" + ], + "query": [ + { + "description": "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.", + "key": "versionId", + "value": "draft" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/{{flowId}}:validate?versionId=draft&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"valid\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Validation result.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:validate" + ], + "query": [ + { + "description": "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.", + "key": "versionId", + "value": "draft" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/{{flowId}}:validate?versionId=draft&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "OK" + } + ] + }, + { + "name": "Export a Flow", + "request": { + "description": "Export a flow as a flow document for backup, migration, or version control.\n\nScope: `cjp:config_read`", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:export" + ], + "query": [ + { + "description": "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.", + "key": "version", + "value": "latest" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/{{flowId}}:export?version=latest&flowType=FLOW", + "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": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:export" + ], + "query": [ + { + "description": "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.", + "key": "version", + "value": "latest" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/{{flowId}}:export?version=latest&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:export" + ], + "query": [ + { + "description": "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.", + "key": "version", + "value": "latest" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/{{flowId}}:export?version=latest&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:export" + ], + "query": [ + { + "description": "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.", + "key": "version", + "value": "latest" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/{{flowId}}:export?version=latest&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 370\n },\n \"outputs\": {\n \"key_0\": 905,\n \"key_1\": 3471.4719949571804\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4622.9748867488115,\n \"key_1\": 8961.95884841\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 1542.1767525441821,\n \"key_3\": 6862.139210764426\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 1372.5015254671337\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8530.762842521233\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 5789\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": 7525.865282388107\n },\n \"outputs\": {\n \"key_0\": 3834.599847246518\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true,\n \"key_1\": 6053.048227977718,\n \"key_2\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 543.5312646510693,\n \"key_1\": 7768,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 604.9674007362671\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 121\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9189.527303161643\n },\n \"outputs\": {\n \"key_0\": 9645.274237076525\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 193\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2429\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 8823.210004635783,\n \"key_1\": true,\n \"key_2\": 3323.539757579088,\n \"key_3\": 6459.862970859948,\n \"key_4\": false\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9138\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Flow JSON document.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:export" + ], + "query": [ + { + "description": "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.", + "key": "version", + "value": "latest" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/{{flowId}}:export?version=latest&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:export" + ], + "query": [ + { + "description": "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.", + "key": "version", + "value": "latest" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/flows/{{flowId}}:export?version=latest&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + } + ] + }, + { + "name": "List Flows or Subflows", + "request": { + "description": "Returns a list of flows in response. Channel-based filtering can be applied with the `searchBy` query parameter (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`). Channel visibility may be constrained by organization feature flags. If associatedChannels key is missing or empty, it will be treated as telephony flow.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + }, + { + "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": "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": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "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": "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).", + "key": "searchBy", + "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": "If set 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" + }, + { + "description": "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows?flowType=FLOW&ids=&ids=&page=0&partialNameSearch=&searchBy=&size=10&includePagination=false&isValidation=false", + "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": 403, + "cookie": [], + "header": [], + "name": "Forbidden", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + }, + { + "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": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "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": "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).", + "key": "searchBy", + "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": "If set 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" + }, + { + "description": "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&searchBy=&size=10&includePagination=false&isValidation=false", + "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": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "[\n {\n \"associatedChannels\": [\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\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 \"key_2\": [\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 \"associatedChannels\": [\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\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 \"key_2\": [\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": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + }, + { + "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": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "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": "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).", + "key": "searchBy", + "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": "If set 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" + }, + { + "description": "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&searchBy=&size=10&includePagination=false&isValidation=false", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + }, + { + "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": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "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": "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).", + "key": "searchBy", + "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": "If set 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" + }, + { + "description": "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&searchBy=&size=10&includePagination=false&isValidation=false", + "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": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad request", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + }, + { + "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": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "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": "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).", + "key": "searchBy", + "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": "If set 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" + }, + { + "description": "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&searchBy=&size=10&includePagination=false&isValidation=false", + "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": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + }, + { + "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": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "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": "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).", + "key": "searchBy", + "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": "If set 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" + }, + { + "description": "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&searchBy=&size=10&includePagination=false&isValidation=false", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + }, + { + "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": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "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": "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).", + "key": "searchBy", + "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": "If set 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" + }, + { + "description": "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&searchBy=&size=10&includePagination=false&isValidation=false", + "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": "" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Publish a Flow or Subflow", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "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_write`. 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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" + ], + "query": [ + { + "description": "If true, the flow's pre-publish validation is skipped. Use with care.", + "key": "skipValidation", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:publish?skipValidation=false&flowType=FLOW", + "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, + "cookie": [], + "header": [], + "name": "Unauthorized", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" + ], + "query": [ + { + "description": "If true, the flow's pre-publish validation is skipped. Use with care.", + "key": "skipValidation", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:publish?skipValidation=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" + ], + "query": [ + { + "description": "If true, the flow's pre-publish validation is skipped. Use with care.", + "key": "skipValidation", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:publish?skipValidation=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"associatedChannels\": [\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"assignedRS\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"draftVersion\": {\n \"associatedChannels\": [\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\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 }\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 \"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 \"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 \"flowType\": \"\",\n \"flowVersions\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"latestVersion\": {\n \"associatedChannels\": [\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\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 \"key_3\": {\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 \"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 },\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 \"key_2\": [\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n },\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n }\n ],\n \"key_3\": [\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": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" + ], + "query": [ + { + "description": "If true, the flow's pre-publish validation is skipped. Use with care.", + "key": "skipValidation", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:publish?skipValidation=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad request", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" + ], + "query": [ + { + "description": "If true, the flow's pre-publish validation is skipped. Use with care.", + "key": "skipValidation", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:publish?skipValidation=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 201, + "cookie": [], + "header": [], + "name": "Created", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" + ], + "query": [ + { + "description": "If true, the flow's pre-publish validation is skipped. Use with care.", + "key": "skipValidation", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:publish?skipValidation=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Created" + }, + { + "_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 \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" + ], + "query": [ + { + "description": "If true, the flow's pre-publish validation is skipped. Use with care.", + "key": "skipValidation", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:publish?skipValidation=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" + ], + "query": [ + { + "description": "If true, the flow's pre-publish validation is skipped. Use with care.", + "key": "skipValidation", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:publish?skipValidation=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Lock a Flow or Subflow", + "request": { + "description": "Lock a flow to prevent concurrent edits by other users. Locks expire after 15 minutes of inactivity.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:lock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:lock?flowType=FLOW", + "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": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:lock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:lock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict \u2014 the flow is already locked by another user.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:lock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:lock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:lock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:lock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:lock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:lock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:lock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:lock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Lock confirmation with expiry information.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:lock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:lock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "OK" + } + ] + }, + { + "name": "Unlock a Flow or Subflow", + "request": { + "description": "Release the lock on a flow to allow other users to edit it.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:unlock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:unlock?flowType=FLOW", + "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": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:unlock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:unlock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unlock confirmation.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:unlock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:unlock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:unlock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:unlock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:unlock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:unlock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:unlock" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/{{flowId}}:unlock?flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Validate a Flow or Subflow", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "description": "Dry-run validate a flow/subflow definition without persisting it. Use this to check correctness before importing. Include `associatedChannels` to preserve the channel metadata that import and export payloads round-trip. Validation requests where `associatedChannels` is missing or empty are treated as telephony flows, and dry-run validation does not derive the effective channel from `associatedChannels`.\n\nNote: validation is more lenient than import. A flow that passes `:validate` can still be rejected by `:import` (for example, a missing start activity), so a successful validation does not guarantee a successful import.\n\nScope: `cjp:config_write`", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows:validate" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows:validate", + "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": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows:validate" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows:validate", + "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": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows:validate" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows:validate", + "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": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request \u2014 Invalid flow schema or missing required fields.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows:validate" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows:validate", + "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": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"valid\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"warnings\": [\n {\n \"severity\": \"WARNING\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"severity\": \"WARNING\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"summary\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Validation result.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows:validate" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows:validate", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows:validate" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows:validate", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows:validate" + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows:validate", + "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": "" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Import a Flow or Subflow", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "description": "Import a new flow/subflow from a flow definition. Creates the flow/subflow in draft state and returns the assigned flow metadata, including `flowId`. Include `associatedChannels` in the payload when the flow contains channel-specific activities (for example, `customMessaging`) so channel references can be resolved correctly during import. If `associatedChannels` is missing or empty, the import is treated as a telephony flow. For `FLOW` imports, blank or whitespace-only `associatedChannels[].channelType` values are rejected.\n\nScope: `cjp:config_write`", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"valid\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"warnings\": [\n {\n \"severity\": \"WARNING\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"severity\": \"WARNING\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"summary\": \"\"\n}", + "code": 422, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unprocessable Entity \u2014 flow document failed validation.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Conflict \u2014 a flow with the same name already exists and `overwrite` is false.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"flow\": {\n \"id\": \"\",\n \"orgId\": \"\",\n \"version\": \"\",\n \"flowType\": \"FLOW\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"Draft\",\n \"createdBy\": \"\",\n \"associatedChannels\": [\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"createdDate\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"preflightWarnings\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n {\n \"key_0\": \"string\",\n \"key_1\": 8004\n }\n ],\n \"preflightWarningsCount\": \"\"\n}", + "code": 201, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Created \u2014 flow metadata including the assigned `flowId`.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Created" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows:import" + ], + "query": [ + { + "description": "If true, replaces an existing flow with the same name. Defaults to false.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows:import?overwrite=false&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "Get a Flow or Subflow", + "request": { + "description": "Retrieve the current draft of a flow/subflow as a flow document. To fetch a specific published version, use the `:export` endpoint. The response includes channel metadata (for example, `associatedChannels`) used by channel-specific activities such as `customMessaging`. If `associatedChannels` is missing or empty, the flow is treated as telephony.\n\nScope: `cjp:config_read`", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Flow JSON document.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + } + ] + }, + { + "name": "Save a Flow or Subflow Draft", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "description": "Save a complete flow/subflow document as the current draft, replacing the existing draft. Submitted `associatedChannels` values are not persisted on save; the draft preserves the existing stored channel metadata. Omitting `associatedChannels` does not default an existing flow to telephony. Pass `expectedVersion` as a query parameter to enable optimistic locking; the request fails with `409 Conflict` if the server-side version does not match. Omit `expectedVersion` to skip the check.\n\nScope: `cjp:config_write`", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict \u2014 `expectedVersion` does not match the current draft version.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"flow\": {\n \"id\": \"\",\n \"orgId\": \"\",\n \"version\": \"\",\n \"flowType\": \"FLOW\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"Draft\",\n \"createdBy\": \"\",\n \"associatedChannels\": [\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"createdDate\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"preflightWarnings\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n {\n \"key_0\": \"string\",\n \"key_1\": 8004\n }\n ],\n \"preflightWarningsCount\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Updated flow metadata, including the new `version`.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"valid\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"warnings\": [\n {\n \"severity\": \"WARNING\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"severity\": \"WARNING\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"summary\": \"\"\n}", + "code": 422, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unprocessable Entity \u2014 flow document failed validation.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)" + } + ] + }, + { + "name": "Patch a Flow or Subflow Draft", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 996,\n \"key_1\": 5930.932937672046,\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": \"string\"\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 8720\n },\n {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "description": "Apply partial updates to an existing flow/subflow draft without replacing the entire document. The patch body is a Patch Draft Contract \u2014 server-side merge, idempotent, and re-validated after the merge. The patch is rejected if the merged document fails validation, so the draft is never left in a broken state. The body may also include top-level overrides such as `name` and `description`. Submitted `associatedChannels` values are not persisted on patch; the draft preserves the existing stored channel metadata.\n\nPass `expectedVersion` as a query parameter to enable optimistic locking; the request fails with `409 Conflict` if the server-side version does not match. Omit `expectedVersion` to skip the check.\n\nScope: `cjp:config_write`", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 996,\n \"key_1\": 5930.932937672046,\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": \"string\"\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 8720\n },\n {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 996,\n \"key_1\": 5930.932937672046,\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": \"string\"\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 8720\n },\n {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 996,\n \"key_1\": 5930.932937672046,\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": \"string\"\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 8720\n },\n {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 996,\n \"key_1\": 5930.932937672046,\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": \"string\"\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 8720\n },\n {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"valid\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"warnings\": [\n {\n \"severity\": \"WARNING\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"severity\": \"WARNING\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"summary\": \"\"\n}", + "code": 422, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unprocessable Entity \u2014 merged flow document failed validation.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 996,\n \"key_1\": 5930.932937672046,\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": \"string\"\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 8720\n },\n {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"flow\": {\n \"id\": \"\",\n \"orgId\": \"\",\n \"version\": \"\",\n \"flowType\": \"FLOW\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"Draft\",\n \"createdBy\": \"\",\n \"associatedChannels\": [\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"createdDate\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"preflightWarnings\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n {\n \"key_0\": \"string\",\n \"key_1\": 8004\n }\n ],\n \"preflightWarningsCount\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Updated flow metadata, including the new `version`.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 996,\n \"key_1\": 5930.932937672046,\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": \"string\"\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 8720\n },\n {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"path\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 996,\n \"key_1\": 5930.932937672046,\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": \"string\"\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 8720\n },\n {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict \u2014 `expectedVersion` does not match the current draft version.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"upsert_nodes\": [\n {\n \"key_0\": 996,\n \"key_1\": 5930.932937672046,\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": true,\n \"key_2\": \"string\"\n }\n ],\n \"upsert_edges\": [\n {\n \"key_0\": 8720\n },\n {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n ],\n \"remove_node_names\": [\n \"\",\n \"\"\n ],\n \"remove_edge_keys\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + ":flowId" + ], + "query": [ + { + "description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.", + "key": "expectedVersion", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/:flowId?expectedVersion=&flowType=FLOW", + "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": "" + }, + { + "description": "Flow ID.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Conflict" + } + ] + }, + { + "name": "Validate an Existing Flow or Subflow Draft", + "request": { + "description": "Validate the current draft of an existing flow/subflow (read-only operation). Validation reads the draft as stored. Drafts where `associatedChannels` is missing or empty are treated as telephony flows, and validation does not derive the effective channel from `associatedChannels`.\n\nScope: `cjp:config_read`", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:validate" + ], + "query": [ + { + "description": "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.", + "key": "versionId", + "value": "draft" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/{{flowId}}:validate?versionId=draft&flowType=FLOW", + "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": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:validate" + ], + "query": [ + { + "description": "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.", + "key": "versionId", + "value": "draft" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/{{flowId}}:validate?versionId=draft&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"valid\": \"\",\n \"results\": [\n {\n \"code\": \"\",\n \"docLink\": \"\",\n \"hint\": \"\",\n \"message\": \"\",\n \"severity\": \"RECOMMENDATION\",\n \"activityLabel\": \"\"\n },\n {\n \"code\": \"\",\n \"docLink\": \"\",\n \"hint\": \"\",\n \"message\": \"\",\n \"severity\": \"RECOMMENDATION\",\n \"activityLabel\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Validation result.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:validate" + ], + "query": [ + { + "description": "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.", + "key": "versionId", + "value": "draft" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/{{flowId}}:validate?versionId=draft&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:validate" + ], + "query": [ + { + "description": "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.", + "key": "versionId", + "value": "draft" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/{{flowId}}:validate?versionId=draft&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:validate" + ], + "query": [ + { + "description": "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.", + "key": "versionId", + "value": "draft" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/{{flowId}}:validate?versionId=draft&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:validate" + ], + "query": [ + { + "description": "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.", + "key": "versionId", + "value": "draft" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/{{flowId}}:validate?versionId=draft&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "Export a Flow or Subflow", + "request": { + "description": "Export a flow/subflow as a flow document for backup, migration, or version control. The exported payload includes `associatedChannels` metadata to preserve channel-specific activity behavior (for example, `customMessaging`) during re-import. If `associatedChannels` is missing or empty, the flow is treated as telephony.\n\nScope: `cjp:config_read`", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:export" + ], + "query": [ + { + "description": "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.", + "key": "version", + "value": "latest" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/{{flowId}}:export?version=latest&flowType=FLOW", + "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 \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1773.175471045585,\n \"key_1\": true,\n \"key_2\": 1817,\n \"key_3\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": 7057.03855684229\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3032.7004364227796,\n \"key_1\": 750,\n \"key_2\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 7400,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7133.061899885671\n },\n \"outputs\": {\n \"key_0\": 3383.0848678062166,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3873,\n \"key_1\": 7394\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 5456.84853825106\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 9120\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Flow JSON document.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:export" + ], + "query": [ + { + "description": "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.", + "key": "version", + "value": "latest" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/{{flowId}}:export?version=latest&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:export" + ], + "query": [ + { + "description": "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.", + "key": "version", + "value": "latest" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/{{flowId}}:export?version=latest&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:export" + ], + "query": [ + { + "description": "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.", + "key": "version", + "value": "latest" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/{{flowId}}:export?version=latest&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:export" + ], + "query": [ + { + "description": "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.", + "key": "version", + "value": "latest" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/{{flowId}}:export?version=latest&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "v2", + "flows", + "{{flowId}}:export" + ], + "query": [ + { + "description": "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.", + "key": "version", + "value": "latest" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/v2/flows/{{flowId}}:export?version=latest&flowType=FLOW", + "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": "" + } + ] + } + }, + "status": "Forbidden" + } + ] + }, + { + "name": "Search Flows", + "request": { + "description": "Returns a list of flows in response. The search is case-sensitive.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows:search" + ], + "query": [ + { + "description": "Searches for flows with the given query. The search is case-sensitive.", + "key": "query", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW' or 'ALL'. Default value is 'ALL'.", + "key": "flowType", + "value": "ALL" + }, + { + "description": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If 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": "100" + }, + { + "description": "Filters results based on key-value pairs. Format: 'key1|value1,key2|value2'. This will add a filter on normalizedFlow collection directly instead of running query on atlas.", + "key": "keyValueFilter", + "value": "" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows:search?query=&flowType=ALL&page=0&size=100&keyValueFilter=", + "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 \"pageInfo\": {\n \"currentPage\": \"\",\n \"totalRecords\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\"\n },\n \"data\": [\n {\n \"orgId\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"flowType\": \"\",\n \"lastModifiedDate\": \"\"\n },\n {\n \"orgId\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"flowType\": \"\",\n \"lastModifiedDate\": \"\"\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": [ + ":orgId", + "project", + ":projectId", + "flows:search" + ], + "query": [ + { + "description": "Searches for flows with the given query. The search is case-sensitive.", + "key": "query", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW' or 'ALL'. Default value is 'ALL'.", + "key": "flowType", + "value": "ALL" + }, + { + "description": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If 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": "100" + }, + { + "description": "Filters results based on key-value pairs. Format: 'key1|value1,key2|value2'. This will add a filter on normalizedFlow collection directly instead of running query on atlas.", + "key": "keyValueFilter", + "value": "" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows:search?query=&flowType=ALL&page=0&size=100&keyValueFilter=", + "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": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows:search" + ], + "query": [ + { + "description": "Searches for flows with the given query. The search is case-sensitive.", + "key": "query", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW' or 'ALL'. Default value is 'ALL'.", + "key": "flowType", + "value": "ALL" + }, + { + "description": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If 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": "100" + }, + { + "description": "Filters results based on key-value pairs. Format: 'key1|value1,key2|value2'. This will add a filter on normalizedFlow collection directly instead of running query on atlas.", + "key": "keyValueFilter", + "value": "" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows:search?query=&flowType=ALL&page=0&size=100&keyValueFilter=", + "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": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows:search" + ], + "query": [ + { + "description": "Searches for flows with the given query. The search is case-sensitive.", + "key": "query", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW' or 'ALL'. Default value is 'ALL'.", + "key": "flowType", + "value": "ALL" + }, + { + "description": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If 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": "100" + }, + { + "description": "Filters results based on key-value pairs. Format: 'key1|value1,key2|value2'. This will add a filter on normalizedFlow collection directly instead of running query on atlas.", + "key": "keyValueFilter", + "value": "" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows:search?query=&flowType=ALL&page=0&size=100&keyValueFilter=", + "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": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad request", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows:search" + ], + "query": [ + { + "description": "Searches for flows with the given query. The search is case-sensitive.", + "key": "query", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW' or 'ALL'. Default value is 'ALL'.", + "key": "flowType", + "value": "ALL" + }, + { + "description": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If 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": "100" + }, + { + "description": "Filters results based on key-value pairs. Format: 'key1|value1,key2|value2'. This will add a filter on normalizedFlow collection directly instead of running query on atlas.", + "key": "keyValueFilter", + "value": "" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows:search?query=&flowType=ALL&page=0&size=100&keyValueFilter=", + "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": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows:search" + ], + "query": [ + { + "description": "Searches for flows with the given query. The search is case-sensitive.", + "key": "query", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW' or 'ALL'. Default value is 'ALL'.", + "key": "flowType", + "value": "ALL" + }, + { + "description": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If 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": "100" + }, + { + "description": "Filters results based on key-value pairs. Format: 'key1|value1,key2|value2'. This will add a filter on normalizedFlow collection directly instead of running query on atlas.", + "key": "keyValueFilter", + "value": "" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows:search?query=&flowType=ALL&page=0&size=100&keyValueFilter=", + "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": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows:search" + ], + "query": [ + { + "description": "Searches for flows with the given query. The search is case-sensitive.", + "key": "query", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW' or 'ALL'. Default value is 'ALL'.", + "key": "flowType", + "value": "ALL" + }, + { + "description": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If 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": "100" + }, + { + "description": "Filters results based on key-value pairs. Format: 'key1|value1,key2|value2'. This will add a filter on normalizedFlow collection directly instead of running query on atlas.", + "key": "keyValueFilter", + "value": "" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows:search?query=&flowType=ALL&page=0&size=100&keyValueFilter=", + "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": "" + } + ] + } + }, + "status": "Forbidden" + } + ] + }, + { + "name": "Delete a Flow or Subflow", + "request": { + "description": "Permanently deletes a flow or subflow. Flows deleted via this API are removed permanently and cannot be recovered.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + ":flowId" + ], + "query": [ + { + "description": "If 'yes', the flow is deleted even if it is still referenced by other entities. Defaults to 'no'.", + "key": "force", + "value": "no" + }, + { + "description": "If true, skips the check for routing strategy and entry point associations before deleting the flow.", + "key": "skipRsEPCheck", + "value": "true" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/:flowId?force=no&skipRsEPCheck=true&flowType=FLOW", + "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": "" + }, + { + "description": "ID of the flow/subflow to delete.", + "key": "flowId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + ":flowId" + ], + "query": [ + { + "description": "If 'yes', the flow is deleted even if it is still referenced by other entities. Defaults to 'no'.", + "key": "force", + "value": "no" + }, + { + "description": "If true, skips the check for routing strategy and entry point associations before deleting the flow.", + "key": "skipRsEPCheck", + "value": "true" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/:flowId?force=no&skipRsEPCheck=true&flowType=FLOW", + "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": "" + }, + { + "description": "ID of the flow/subflow to delete.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + ":flowId" + ], + "query": [ + { + "description": "If 'yes', the flow is deleted even if it is still referenced by other entities. Defaults to 'no'.", + "key": "force", + "value": "no" + }, + { + "description": "If true, skips the check for routing strategy and entry point associations before deleting the flow.", + "key": "skipRsEPCheck", + "value": "true" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/:flowId?force=no&skipRsEPCheck=true&flowType=FLOW", + "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": "" + }, + { + "description": "ID of the flow/subflow to delete.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + ":flowId" + ], + "query": [ + { + "description": "If 'yes', the flow is deleted even if it is still referenced by other entities. Defaults to 'no'.", + "key": "force", + "value": "no" + }, + { + "description": "If true, skips the check for routing strategy and entry point associations before deleting the flow.", + "key": "skipRsEPCheck", + "value": "true" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/:flowId?force=no&skipRsEPCheck=true&flowType=FLOW", + "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": "" + }, + { + "description": "ID of the flow/subflow to delete.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + ":flowId" + ], + "query": [ + { + "description": "If 'yes', the flow is deleted even if it is still referenced by other entities. Defaults to 'no'.", + "key": "force", + "value": "no" + }, + { + "description": "If true, skips the check for routing strategy and entry point associations before deleting the flow.", + "key": "skipRsEPCheck", + "value": "true" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/:flowId?force=no&skipRsEPCheck=true&flowType=FLOW", + "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": "" + }, + { + "description": "ID of the flow/subflow to delete.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + ":orgId", + "project", + ":projectId", + "flows", + ":flowId" + ], + "query": [ + { + "description": "If 'yes', the flow is deleted even if it is still referenced by other entities. Defaults to 'no'.", + "key": "force", + "value": "no" + }, + { + "description": "If true, skips the check for routing strategy and entry point associations before deleting the flow.", + "key": "skipRsEPCheck", + "value": "true" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/:flowId?force=no&skipRsEPCheck=true&flowType=FLOW", + "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": "" + }, + { + "description": "ID of the flow/subflow to delete.", + "key": "flowId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_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 \"override\": \"\",\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 \"socialId\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "person", - "merge-identities", - "workspace-id", - ":workspaceId" + ":orgId", + "project", + ":projectId", + "flows", + ":flowId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/merge-identities/workspace-id/:workspaceId", + "query": [ + { + "description": "If 'yes', the flow is deleted even if it is still referenced by other entities. Defaults to 'no'.", + "key": "force", + "value": "no" + }, + { + "description": "If true, skips the check for routing strategy and entry point associations before deleting the flow.", + "key": "skipRsEPCheck", + "value": "true" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/:orgId/project/:projectId/flows/:flowId?force=no&skipRsEPCheck=true&flowType=FLOW", "variable": [ { - "description": "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": "" + }, + { + "description": "ID of the flow/subflow to delete.", + "key": "flowId", + "value": "" } ] } @@ -171946,11 +206491,16 @@ "status": "Internal Server Error" } ] - }, + } + ], + "name": "Flows" + }, + { + "item": [ { - "name": "Search for an Identity via aliases", + "name": "List Custom Functions", "request": { - "description": "Get one or more Person Details searched by aliases in JDS. Multiple aliases should be separated by a comma.\n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or it requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "description": "List or search custom functions in the organization. Without filters, returns all custom functions. Supports filtering by name, language, and status, plus sorting and pagination.\n\nScope: `cjp:config_read`", "header": [ { "key": "Accept", @@ -171963,60 +206513,183 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "person", - "workspace-id", - ":workspaceId", - "aliases", - ":aliases" + ":orgId", + "functions" ], "query": [ { - "description": "Sort By Field", - "key": "sortBy", + "description": "Whether to search with partial matches. If `false`, search/filter is based on exact match.", + "key": "isPartialMatch", + "value": "true" + }, + { + "description": "Whether the search should be case-sensitive. Currently applicable only to the `name` field.", + "key": "isCaseSensitive", + "value": "false" + }, + { + "description": "Filter by function name.", + "key": "name", "value": "" }, { - "description": "Sort direction", - "key": "sort", + "description": "Filter by programming language.", + "key": "language", + "value": "py" + }, + { + "description": "Filter by one or more function statuses (comma-separated, no spaces). Case-sensitive.", + "key": "status", "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": "Comma-separated fields with order. Supported fields (case-sensitive): `name`, `language`, `status`, `lastModifiedDate`. Prefix a field with `-` for descending order; no prefix means ascending.", + "key": "sortBy", + "value": "" + }, + { + "description": "Zero-based page number for the paginated query.", "key": "page", - "value": "" + "value": "0" }, { - "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": [ + "description": "Number of results per page.", + "key": "size", + "value": "100" + }, { - "description": "Workspace ID", - "key": "workspaceId", + "description": "Comma-separated list of function IDs to fetch.", + "key": "ids", "value": "" }, { - "description": "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": "Comma-separated list of function fields to include in the response.", + "key": "fields", + "value": "" + }, + { + "description": "Used by the Tenant Management team to validate the existence of functions with given IDs regardless of the user's RBAC access.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions?isPartialMatch=true&isCaseSensitive=false&name=&language=py&status=&sortBy=&page=0&size=100&ids=&fields=&isValidation=false", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId", "value": "" } ] } }, "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"orgId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"status\": \"Published\",\n \"timeoutInSec\": \"\",\n \"tagVersionMap\": {\n \"key_0\": 5137.951715623208\n },\n \"lockedBy\": \"\",\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\"\n },\n {\n \"id\": \"\",\n \"orgId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"language\": \"py\",\n \"selectedRuntime\": \"\",\n \"status\": \"Published\",\n \"timeoutInSec\": \"\",\n \"tagVersionMap\": {\n \"key_0\": \"string\",\n \"key_1\": 5683.890168768368,\n \"key_2\": 8434.55510232976\n },\n \"lockedBy\": \"\",\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\"\n }\n ],\n \"pageInfo\": {\n \"currentPage\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"key_0\": 8306\n }\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Custom functions retrieved successfully.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + ":orgId", + "functions" + ], + "query": [ + { + "description": "Whether to search with partial matches. If `false`, search/filter is based on exact match.", + "key": "isPartialMatch", + "value": "true" + }, + { + "description": "Whether the search should be case-sensitive. Currently applicable only to the `name` field.", + "key": "isCaseSensitive", + "value": "false" + }, + { + "description": "Filter by function name.", + "key": "name", + "value": "" + }, + { + "description": "Filter by programming language.", + "key": "language", + "value": "py" + }, + { + "description": "Filter by one or more function statuses (comma-separated, no spaces). Case-sensitive.", + "key": "status", + "value": "" + }, + { + "description": "Comma-separated fields with order. Supported fields (case-sensitive): `name`, `language`, `status`, `lastModifiedDate`. Prefix a field with `-` for descending order; no prefix means ascending.", + "key": "sortBy", + "value": "" + }, + { + "description": "Zero-based page number for the paginated query.", + "key": "page", + "value": "0" + }, + { + "description": "Number of results per page.", + "key": "size", + "value": "100" + }, + { + "description": "Comma-separated list of function IDs to fetch.", + "key": "ids", + "value": "" + }, + { + "description": "Comma-separated list of function fields to include in the response.", + "key": "fields", + "value": "" + }, + { + "description": "Used by the Tenant Management team to validate the existence of functions with given IDs regardless of the user's RBAC access.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions?isPartialMatch=true&isCaseSensitive=false&name=&language=py&status=&sortBy=&page=0&size=100&ids=&fields=&isValidation=false", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId", + "value": "" + } + ] + } + }, + "status": "OK" + }, { "_postman_previewlanguage": "text", "body": null, "code": 404, "cookie": [], "header": [], - "name": "Not found", + "name": "No records found matching the supplied filters.", "originalRequest": { "header": [], "method": "GET", @@ -172025,46 +206698,73 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "person", - "workspace-id", - ":workspaceId", - "aliases", - ":aliases" + ":orgId", + "functions" ], "query": [ { - "description": "Sort By Field", - "key": "sortBy", + "description": "Whether to search with partial matches. If `false`, search/filter is based on exact match.", + "key": "isPartialMatch", + "value": "true" + }, + { + "description": "Whether the search should be case-sensitive. Currently applicable only to the `name` field.", + "key": "isCaseSensitive", + "value": "false" + }, + { + "description": "Filter by function name.", + "key": "name", "value": "" }, { - "description": "Sort direction", - "key": "sort", + "description": "Filter by programming language.", + "key": "language", + "value": "py" + }, + { + "description": "Filter by one or more function statuses (comma-separated, no spaces). Case-sensitive.", + "key": "status", "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": "Comma-separated fields with order. Supported fields (case-sensitive): `name`, `language`, `status`, `lastModifiedDate`. Prefix a field with `-` for descending order; no prefix means ascending.", + "key": "sortBy", + "value": "" + }, + { + "description": "Zero-based page number for the paginated query.", "key": "page", - "value": "" + "value": "0" }, { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" + "description": "Number of results per page.", + "key": "size", + "value": "100" + }, + { + "description": "Comma-separated list of function IDs to fetch.", + "key": "ids", + "value": "" + }, + { + "description": "Comma-separated list of function fields to include in the response.", + "key": "fields", + "value": "" + }, + { + "description": "Used by the Tenant Management team to validate the existence of functions with given IDs regardless of the user's RBAC access.", + "key": "isValidation", + "value": "false" } ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/aliases/:aliases?sortBy=&sort=&page=&pageSize=", + "raw": "{{baseUrl}}/v1/:orgId/functions?isPartialMatch=true&isCaseSensitive=false&name=&language=py&status=&sortBy=&page=0&size=100&ids=&fields=&isValidation=false", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "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": "Organization ID.", + "key": "orgId", + "value": "" } ] } @@ -172073,8 +206773,8 @@ }, { "_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 \"code\": \"\",\n \"message\": \"\"\n}", + "code": 500, "cookie": [], "header": [ { @@ -172082,7 +206782,7 @@ "value": "application/json" } ], - "name": "Success", + "name": "Internal Server Error.", "originalRequest": { "header": [ { @@ -172096,59 +206796,184 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "person", - "workspace-id", - ":workspaceId", - "aliases", - ":aliases" + ":orgId", + "functions" ], "query": [ { - "description": "Sort By Field", - "key": "sortBy", + "description": "Whether to search with partial matches. If `false`, search/filter is based on exact match.", + "key": "isPartialMatch", + "value": "true" + }, + { + "description": "Whether the search should be case-sensitive. Currently applicable only to the `name` field.", + "key": "isCaseSensitive", + "value": "false" + }, + { + "description": "Filter by function name.", + "key": "name", "value": "" }, { - "description": "Sort direction", - "key": "sort", + "description": "Filter by programming language.", + "key": "language", + "value": "py" + }, + { + "description": "Filter by one or more function statuses (comma-separated, no spaces). Case-sensitive.", + "key": "status", "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": "Comma-separated fields with order. Supported fields (case-sensitive): `name`, `language`, `status`, `lastModifiedDate`. Prefix a field with `-` for descending order; no prefix means ascending.", + "key": "sortBy", + "value": "" + }, + { + "description": "Zero-based page number for the paginated query.", "key": "page", - "value": "" + "value": "0" }, { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" + "description": "Number of results per page.", + "key": "size", + "value": "100" + }, + { + "description": "Comma-separated list of function IDs to fetch.", + "key": "ids", + "value": "" + }, + { + "description": "Comma-separated list of function fields to include in the response.", + "key": "fields", + "value": "" + }, + { + "description": "Used by the Tenant Management team to validate the existence of functions with given IDs regardless of the user's RBAC access.", + "key": "isValidation", + "value": "false" } ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/aliases/:aliases?sortBy=&sort=&page=&pageSize=", + "raw": "{{baseUrl}}/v1/:orgId/functions?isPartialMatch=true&isCaseSensitive=false&name=&language=py&status=&sortBy=&page=0&size=100&ids=&fields=&isValidation=false", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request. A required parameter was missing or had an invalid format.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + ":orgId", + "functions" + ], + "query": [ + { + "description": "Whether to search with partial matches. If `false`, search/filter is based on exact match.", + "key": "isPartialMatch", + "value": "true" }, { - "description": "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": "Whether the search should be case-sensitive. Currently applicable only to the `name` field.", + "key": "isCaseSensitive", + "value": "false" + }, + { + "description": "Filter by function name.", + "key": "name", + "value": "" + }, + { + "description": "Filter by programming language.", + "key": "language", + "value": "py" + }, + { + "description": "Filter by one or more function statuses (comma-separated, no spaces). Case-sensitive.", + "key": "status", + "value": "" + }, + { + "description": "Comma-separated fields with order. Supported fields (case-sensitive): `name`, `language`, `status`, `lastModifiedDate`. Prefix a field with `-` for descending order; no prefix means ascending.", + "key": "sortBy", + "value": "" + }, + { + "description": "Zero-based page number for the paginated query.", + "key": "page", + "value": "0" + }, + { + "description": "Number of results per page.", + "key": "size", + "value": "100" + }, + { + "description": "Comma-separated list of function IDs to fetch.", + "key": "ids", + "value": "" + }, + { + "description": "Comma-separated list of function fields to include in the response.", + "key": "fields", + "value": "" + }, + { + "description": "Used by the Tenant Management team to validate the existence of functions with given IDs regardless of the user's RBAC access.", + "key": "isValidation", + "value": "false" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions?isPartialMatch=true&isCaseSensitive=false&name=&language=py&status=&sortBy=&page=0&size=100&ids=&fields=&isValidation=false", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "OK" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 401, "cookie": [], "header": [], - "name": "Internal error", + "name": "Unauthorized.", "originalRequest": { "header": [], "method": "GET", @@ -172157,61 +206982,83 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "person", - "workspace-id", - ":workspaceId", - "aliases", - ":aliases" + ":orgId", + "functions" ], "query": [ { - "description": "Sort By Field", - "key": "sortBy", + "description": "Whether to search with partial matches. If `false`, search/filter is based on exact match.", + "key": "isPartialMatch", + "value": "true" + }, + { + "description": "Whether the search should be case-sensitive. Currently applicable only to the `name` field.", + "key": "isCaseSensitive", + "value": "false" + }, + { + "description": "Filter by function name.", + "key": "name", "value": "" }, { - "description": "Sort direction", - "key": "sort", + "description": "Filter by programming language.", + "key": "language", + "value": "py" + }, + { + "description": "Filter by one or more function statuses (comma-separated, no spaces). Case-sensitive.", + "key": "status", "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": "Comma-separated fields with order. Supported fields (case-sensitive): `name`, `language`, `status`, `lastModifiedDate`. Prefix a field with `-` for descending order; no prefix means ascending.", + "key": "sortBy", + "value": "" + }, + { + "description": "Zero-based page number for the paginated query.", "key": "page", - "value": "" + "value": "0" }, { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" + "description": "Number of results per page.", + "key": "size", + "value": "100" + }, + { + "description": "Comma-separated list of function IDs to fetch.", + "key": "ids", + "value": "" + }, + { + "description": "Comma-separated list of function fields to include in the response.", + "key": "fields", + "value": "" + }, + { + "description": "Used by the Tenant Management team to validate the existence of functions with given IDs regardless of the user's RBAC access.", + "key": "isValidation", + "value": "false" } ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/aliases/:aliases?sortBy=&sort=&page=&pageSize=", + "raw": "{{baseUrl}}/v1/:orgId/functions?isPartialMatch=true&isCaseSensitive=false&name=&language=py&status=&sortBy=&page=0&size=100&ids=&fields=&isValidation=false", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "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": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" } ] - } - ], - "name": "Journey - Customer Identification API" - }, - { - "item": [ + }, { - "name": "Journey Event Posting", + "name": "Create a Custom Function", "request": { "body": { "mode": "raw", @@ -172221,9 +207068,9 @@ "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}" + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"timeoutInSec\": \"\",\n \"sourceCode\": \"\",\n \"inputs\": [\n {\n \"name\": \"\",\n \"dataType\": \"boolean\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"dataType\": \"string\",\n \"value\": \"\",\n \"key_0\": false,\n \"key_1\": false\n }\n ],\n \"outputs\": \"\"\n}" }, - "description": "Journey Event Posting 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. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or any role with cjp:config_write scope.", + "description": "Create a new custom function. The source code is provided as an escaped string and the runtime defaults to the highest supported runtime for the given language.\n\nScope: `cjp:config_write`", "header": [ { "key": "Content-Type", @@ -172240,26 +207087,25 @@ "{{baseUrl}}" ], "path": [ - "publish", "v1", - "api", - "event" + ":orgId", + "functions" ], - "query": [ + "raw": "{{baseUrl}}/v1/:orgId/functions", + "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", + "description": "Organization ID.", + "key": "orgId", "value": "" } - ], - "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + ] } }, "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 500, + "body": "{\n \"fnCode\": \"\",\n \"fnMetadata\": {\n \"id\": \"\",\n \"orgId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"status\": \"Published\",\n \"timeoutInSec\": \"\",\n \"tagVersionMap\": {\n \"key_0\": 7775.425818174757\n },\n \"lockedBy\": \"\",\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\"\n }\n}", + "code": 201, "cookie": [], "header": [ { @@ -172267,7 +207113,7 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Custom function created successfully.", "originalRequest": { "body": { "mode": "raw", @@ -172277,7 +207123,7 @@ "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}" + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"timeoutInSec\": \"\",\n \"sourceCode\": \"\",\n \"inputs\": [\n {\n \"name\": \"\",\n \"dataType\": \"boolean\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"dataType\": \"string\",\n \"value\": \"\",\n \"key_0\": false,\n \"key_1\": false\n }\n ],\n \"outputs\": \"\"\n}" }, "header": [ { @@ -172295,27 +207141,26 @@ "{{baseUrl}}" ], "path": [ - "publish", "v1", - "api", - "event" + ":orgId", + "functions" ], - "query": [ + "raw": "{{baseUrl}}/v1/:orgId/functions", + "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", + "description": "Organization ID.", + "key": "orgId", "value": "" } - ], - "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + ] } }, - "status": "Internal Server Error" + "status": "Created" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 404, + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 500, "cookie": [], "header": [ { @@ -172323,7 +207168,7 @@ "value": "application/json" } ], - "name": "Resource not found", + "name": "Internal Server Error.", "originalRequest": { "body": { "mode": "raw", @@ -172333,7 +207178,7 @@ "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}" + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"timeoutInSec\": \"\",\n \"sourceCode\": \"\",\n \"inputs\": [\n {\n \"name\": \"\",\n \"dataType\": \"boolean\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"dataType\": \"string\",\n \"value\": \"\",\n \"key_0\": false,\n \"key_1\": false\n }\n ],\n \"outputs\": \"\"\n}" }, "header": [ { @@ -172351,27 +207196,26 @@ "{{baseUrl}}" ], "path": [ - "publish", "v1", - "api", - "event" + ":orgId", + "functions" ], - "query": [ + "raw": "{{baseUrl}}/v1/:orgId/functions", + "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", + "description": "Organization ID.", + "key": "orgId", "value": "" } - ], - "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 409, + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 400, "cookie": [], "header": [ { @@ -172379,7 +207223,7 @@ "value": "application/json" } ], - "name": "Resource already exists", + "name": "Bad Request. Causes include: function body missing or malformed payload.", "originalRequest": { "body": { "mode": "raw", @@ -172389,7 +207233,7 @@ "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}" + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"timeoutInSec\": \"\",\n \"sourceCode\": \"\",\n \"inputs\": [\n {\n \"name\": \"\",\n \"dataType\": \"boolean\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"dataType\": \"string\",\n \"value\": \"\",\n \"key_0\": false,\n \"key_1\": false\n }\n ],\n \"outputs\": \"\"\n}" }, "header": [ { @@ -172407,35 +207251,29 @@ "{{baseUrl}}" ], "path": [ - "publish", "v1", - "api", - "event" + ":orgId", + "functions" ], - "query": [ + "raw": "{{baseUrl}}/v1/:orgId/functions", + "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", + "description": "Organization ID.", + "key": "orgId", "value": "" } - ], - "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + ] } }, - "status": "Conflict" + "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\",\n \"workspaceId\": \"\"\n },\n \"data\": {\n \"message\": \"\"\n }\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Ok", + "header": [], + "name": "Unauthorized.", "originalRequest": { "body": { "mode": "raw", @@ -172445,16 +207283,12 @@ "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}" + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"timeoutInSec\": \"\",\n \"sourceCode\": \"\",\n \"inputs\": [\n {\n \"name\": \"\",\n \"dataType\": \"boolean\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"dataType\": \"string\",\n \"value\": \"\",\n \"key_0\": false,\n \"key_1\": false\n }\n ],\n \"outputs\": \"\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], "method": "POST", @@ -172463,27 +207297,26 @@ "{{baseUrl}}" ], "path": [ - "publish", "v1", - "api", - "event" + ":orgId", + "functions" ], - "query": [ + "raw": "{{baseUrl}}/v1/:orgId/functions", + "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", + "description": "Organization ID.", + "key": "orgId", "value": "" } - ], - "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + ] } }, - "status": "OK" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 429, + "_postman_previewlanguage": "Text", + "body": "{\n \"status\": \"\",\n \"errors\": [\n {\n \"description\": \"\",\n \"type\": \"\"\n },\n {\n \"description\": \"\",\n \"type\": \"\",\n \"key_0\": 2037.3317149816294,\n \"key_1\": true\n }\n ],\n \"key_0\": \"string\"\n}", + "code": 409, "cookie": [], "header": [ { @@ -172491,7 +207324,7 @@ "value": "application/json" } ], - "name": "Too many requests", + "name": "Conflict. A function with the same name already exists in the org.", "originalRequest": { "body": { "mode": "raw", @@ -172501,7 +207334,7 @@ "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}" + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"timeoutInSec\": \"\",\n \"sourceCode\": \"\",\n \"inputs\": [\n {\n \"name\": \"\",\n \"dataType\": \"json\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"dataType\": \"decimal\",\n \"value\": \"\",\n \"key_0\": \"string\",\n \"key_1\": 8683\n }\n ],\n \"outputs\": \"\"\n}" }, "header": [ { @@ -172519,34 +207352,28 @@ "{{baseUrl}}" ], "path": [ - "publish", "v1", - "api", - "event" + ":orgId", + "functions" ], - "query": [ + "raw": "{{baseUrl}}/v1/:orgId/functions", + "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", + "description": "Organization ID.", + "key": "orgId", "value": "" } - ], - "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + ] } }, - "status": "Too Many Requests" + "status": "Conflict" } ] - } - ], - "name": "Journey - Data Ingestion API" - }, - { - "item": [ + }, { - "name": "Get A specific Template searched by template id", + "name": "Get a Custom Function", "request": { - "description": "Get Template details by template Id in JDS. \n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_write scope.", + "description": "Retrieve a custom function by its ID. Use `versionOrTag` to fetch a specific published version, or omit it to get the draft.\n\nScope: `cjp:config_read`", "header": [ { "key": "Accept", @@ -172559,25 +207386,33 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + ":orgId", + "functions", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", + "query": [ + { + "description": "Version number or publish tag of the source code to return (for example, `Dev`, `Live`, or `2`). If omitted, the draft version is returned.", + "key": "versionOrTag", + "value": "" + }, + { + "description": "If `true`, returns only metadata and excludes source code. If `false` or omitted, returns both metadata and source code.", + "key": "metaDataOnly", + "value": "false" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/:id?versionOrTag=&metaDataOnly=false", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", + "description": "Organization ID.", + "key": "orgId", "value": "" }, { - "description": "Template ID", - "key": "templateId", + "description": "Custom function ID. Hexadecimal ObjectId returned by the create or list APIs.", + "key": "id", "value": "" } ] @@ -172587,10 +207422,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 404, "cookie": [], "header": [], - "name": "Internal error", + "name": "No function found for the supplied ID.", "originalRequest": { "header": [], "method": "GET", @@ -172599,24 +207434,93 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + ":orgId", + "functions", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", + "query": [ + { + "description": "Version number or publish tag of the source code to return (for example, `Dev`, `Live`, or `2`). If omitted, the draft version is returned.", + "key": "versionOrTag", + "value": "" + }, + { + "description": "If `true`, returns only metadata and excludes source code. If `false` or omitted, returns both metadata and source code.", + "key": "metaDataOnly", + "value": "false" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/:id?versionOrTag=&metaDataOnly=false", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" }, { - "description": "Template ID", - "key": "templateId" + "description": "Custom function ID. Hexadecimal ObjectId returned by the create or list APIs.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\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", + ":orgId", + "functions", + ":id" + ], + "query": [ + { + "description": "Version number or publish tag of the source code to return (for example, `Dev`, `Live`, or `2`). If omitted, the draft version is returned.", + "key": "versionOrTag", + "value": "" + }, + { + "description": "If `true`, returns only metadata and excludes source code. If `false` or omitted, returns both metadata and source code.", + "key": "metaDataOnly", + "value": "false" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/:id?versionOrTag=&metaDataOnly=false", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId", + "value": "" + }, + { + "description": "Custom function ID. Hexadecimal ObjectId returned by the create or list APIs.", + "key": "id", + "value": "" } ] } @@ -172626,10 +207530,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 401, "cookie": [], "header": [], - "name": "Not found", + "name": "Unauthorized.", "originalRequest": { "header": [], "method": "GET", @@ -172638,33 +207542,43 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + ":orgId", + "functions", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", + "query": [ + { + "description": "Version number or publish tag of the source code to return (for example, `Dev`, `Live`, or `2`). If omitted, the draft version is returned.", + "key": "versionOrTag", + "value": "" + }, + { + "description": "If `true`, returns only metadata and excludes source code. If `false` or omitted, returns both metadata and source code.", + "key": "metaDataOnly", + "value": "false" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/:id?versionOrTag=&metaDataOnly=false", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" }, { - "description": "Template ID", - "key": "templateId" + "description": "Custom function ID. Hexadecimal ObjectId returned by the create or list APIs.", + "key": "id", + "value": "" } ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_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": "{\n \"fnCode\": \"\",\n \"fnMetadata\": {\n \"id\": \"\",\n \"orgId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"status\": \"Published\",\n \"timeoutInSec\": \"\",\n \"tagVersionMap\": {\n \"key_0\": 7775.425818174757\n },\n \"lockedBy\": \"\",\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\"\n }\n}", "code": 200, "cookie": [], "header": [ @@ -172673,7 +207587,7 @@ "value": "application/json" } ], - "name": "Success", + "name": "Custom function retrieved successfully.", "originalRequest": { "header": [ { @@ -172687,34 +207601,103 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + ":orgId", + "functions", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", + "query": [ + { + "description": "Version number or publish tag of the source code to return (for example, `Dev`, `Live`, or `2`). If omitted, the draft version is returned.", + "key": "versionOrTag", + "value": "" + }, + { + "description": "If `true`, returns only metadata and excludes source code. If `false` or omitted, returns both metadata and source code.", + "key": "metaDataOnly", + "value": "false" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/:id?versionOrTag=&metaDataOnly=false", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" }, { - "description": "Template ID", - "key": "templateId" + "description": "Custom function ID. Hexadecimal ObjectId returned by the create or list APIs.", + "key": "id", + "value": "" } ] } }, "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request. A required parameter was missing or had an invalid format.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + ":orgId", + "functions", + ":id" + ], + "query": [ + { + "description": "Version number or publish tag of the source code to return (for example, `Dev`, `Live`, or `2`). If omitted, the draft version is returned.", + "key": "versionOrTag", + "value": "" + }, + { + "description": "If `true`, returns only metadata and excludes source code. If `false` or omitted, returns both metadata and source code.", + "key": "metaDataOnly", + "value": "false" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/:id?versionOrTag=&metaDataOnly=false", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId", + "value": "" + }, + { + "description": "Custom function ID. Hexadecimal ObjectId returned by the create or list APIs.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Bad Request" } ] }, { - "name": "Update existing ProfileViewTemplate", + "name": "Update a Custom Function", "request": { "body": { "mode": "raw", @@ -172724,9 +207707,9 @@ "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 \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"timeoutInSec\": \"\",\n \"sourceCode\": \"\",\n \"inputs\": [\n {\n \"name\": \"\",\n \"dataType\": \"boolean\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"dataType\": \"string\",\n \"value\": \"\",\n \"key_0\": false,\n \"key_1\": false\n }\n ],\n \"outputs\": \"\"\n}" }, - "description": "Update existing Profile View Template in JDS. \n\nRole and Scope: Requires id full admin or any role with cjp:config_write scope.", + "description": "Update an existing custom function by ID. Replaces the draft source code and metadata with the supplied body.\n\nScope: `cjp:config_write`", "header": [ { "key": "Content-Type", @@ -172743,25 +207726,21 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + ":orgId", + "functions", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/v1/:orgId/functions/:id", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", + "description": "Organization ID.", + "key": "orgId", "value": "" }, { - "description": "Template ID", - "key": "templateId", + "description": "Custom function ID.", + "key": "id", "value": "" } ] @@ -172770,7 +207749,7 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"200 OK\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "code": 400, "cookie": [], "header": [ @@ -172779,7 +207758,7 @@ "value": "application/json" } ], - "name": "Bad Request", + "name": "Bad Request. Causes include: function body missing, malformed payload, or duplicate function name.", "originalRequest": { "body": { "mode": "raw", @@ -172789,7 +207768,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 \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"timeoutInSec\": \"\",\n \"sourceCode\": \"\",\n \"inputs\": [\n {\n \"name\": \"\",\n \"dataType\": \"boolean\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"dataType\": \"string\",\n \"value\": \"\",\n \"key_0\": false,\n \"key_1\": false\n }\n ],\n \"outputs\": \"\"\n}" }, "header": [ { @@ -172807,24 +207786,22 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + ":orgId", + "functions", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/v1/:orgId/functions/:id", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" }, { - "description": "Template ID", - "key": "templateId" + "description": "Custom function ID.", + "key": "id", + "value": "" } ] } @@ -172833,7 +207810,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 \"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": "{\n \"fnCode\": \"\",\n \"fnMetadata\": {\n \"id\": \"\",\n \"orgId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"status\": \"Published\",\n \"timeoutInSec\": \"\",\n \"tagVersionMap\": {\n \"key_0\": 7775.425818174757\n },\n \"lockedBy\": \"\",\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\"\n }\n}", "code": 200, "cookie": [], "header": [ @@ -172842,7 +207819,7 @@ "value": "application/json" } ], - "name": "Ok", + "name": "Custom function updated successfully.", "originalRequest": { "body": { "mode": "raw", @@ -172852,7 +207829,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 \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"timeoutInSec\": \"\",\n \"sourceCode\": \"\",\n \"inputs\": [\n {\n \"name\": \"\",\n \"dataType\": \"boolean\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"dataType\": \"string\",\n \"value\": \"\",\n \"key_0\": false,\n \"key_1\": false\n }\n ],\n \"outputs\": \"\"\n}" }, "header": [ { @@ -172870,24 +207847,22 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + ":orgId", + "functions", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/v1/:orgId/functions/:id", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" }, { - "description": "Template ID", - "key": "templateId" + "description": "Custom function ID.", + "key": "id", + "value": "" } ] } @@ -172896,7 +207871,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "code": 500, "cookie": [], "header": [ @@ -172905,7 +207880,7 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Internal Server Error.", "originalRequest": { "body": { "mode": "raw", @@ -172915,7 +207890,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 \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"timeoutInSec\": \"\",\n \"sourceCode\": \"\",\n \"inputs\": [\n {\n \"name\": \"\",\n \"dataType\": \"boolean\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"dataType\": \"string\",\n \"value\": \"\",\n \"key_0\": false,\n \"key_1\": false\n }\n ],\n \"outputs\": \"\"\n}" }, "header": [ { @@ -172933,106 +207908,22 @@ "{{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": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Template ID", - "key": "templateId" - } - ] - } - }, - "status": "Internal Server Error" - } - ] - }, - { - "name": "Delete Template by template Id", - "request": { - "description": "Delete Template By template id in JDS. \n\nRole and Scope: Requires id full admin or any role with cjp:config_write scope.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "DELETE", - "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": "Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "Template ID", - "key": "templateId", - "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", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + ":orgId", + "functions", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/v1/:orgId/functions/:id", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" }, { - "description": "Template ID", - "key": "templateId" + "description": "Custom function ID.", + "key": "id", + "value": "" } ] } @@ -173042,148 +207933,95 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 404, - "cookie": [], - "header": [], - "name": "Not found", - "originalRequest": { - "header": [], - "method": "DELETE", - "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": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Template ID", - "key": "templateId" - } - ] - } - }, - "status": "Not Found" - }, - { - "_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, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Success", + "header": [], + "name": "Unauthorized.", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"timeoutInSec\": \"\",\n \"sourceCode\": \"\",\n \"inputs\": [\n {\n \"name\": \"\",\n \"dataType\": \"boolean\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"dataType\": \"string\",\n \"value\": \"\",\n \"key_0\": false,\n \"key_1\": false\n }\n ],\n \"outputs\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "DELETE", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + ":orgId", + "functions", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/v1/:orgId/functions/:id", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" }, { - "description": "Template ID", - "key": "templateId" + "description": "Custom function ID.", + "key": "id", + "value": "" } ] } }, - "status": "OK" + "status": "Unauthorized" } ] }, { - "name": "Get All Template Details", + "name": "Delete a Custom Function", "request": { - "description": "Get Template details by Organization Id and workspaceId in JDS. \n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "description": "Delete a custom function by ID. Use `isForceDeletion=true` to delete even when the function is referenced by one or more flows.\n\nScope: `cjp:config_write`", "header": [ { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId" + ":orgId", + "functions", + ":id" ], "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/documentation/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": "" + "description": "If `true`, deletes the function regardless of its usage in flows.", + "key": "isForceDeletion", + "value": "false" } ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId?filter=&sort=&sortBy=&page=&pageSize=", + "raw": "{{baseUrl}}/v1/:orgId/functions/:id?isForceDeletion=false", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", + "description": "Organization ID.", + "key": "orgId", + "value": "" + }, + { + "description": "Custom function ID.", + "key": "id", "value": "" } ] @@ -173191,215 +208029,258 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 404, + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 500, "cookie": [], - "header": [], - "name": "Not found", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Internal Server Error.", "originalRequest": { - "header": [], - "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId" + ":orgId", + "functions", + ":id" ], "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/documentation/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": "If `true`, deletes the function regardless of its usage in flows.", + "key": "isForceDeletion", + "value": "false" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/:id?isForceDeletion=false", + "variable": [ { - "description": "Sort direction", - "key": "sort", + "description": "Organization ID.", + "key": "orgId", "value": "" }, { - "description": "Sort By Field", - "key": "sortBy", + "description": "Custom function ID.", + "key": "id", "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": "" - }, + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + ":orgId", + "functions", + ":id" + ], + "query": [ { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" + "description": "If `true`, deletes the function regardless of its usage in flows.", + "key": "isForceDeletion", + "value": "false" } ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId?filter=&sort=&sortBy=&page=&pageSize=", + "raw": "{{baseUrl}}/v1/:orgId/functions/:id?isForceDeletion=false", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" + }, + { + "description": "Custom function ID.", + "key": "id", + "value": "" } ] } }, - "status": "Not Found" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 401, "cookie": [], "header": [], - "name": "Internal error", + "name": "Unauthorized.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId" + ":orgId", + "functions", + ":id" ], "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/documentation/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": "If `true`, deletes the function regardless of its usage in flows.", + "key": "isForceDeletion", + "value": "false" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/:id?isForceDeletion=false", + "variable": [ { - "description": "Sort direction", - "key": "sort", + "description": "Organization ID.", + "key": "orgId", "value": "" }, { - "description": "Sort By Field", - "key": "sortBy", + "description": "Custom function ID.", + "key": "id", "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": "Workspace ID", - "key": "workspaceId" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { - "_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, + "_postman_previewlanguage": "text", + "body": null, + "code": 404, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Success", + "header": [], + "name": "No function found for the supplied ID.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId" + ":orgId", + "functions", + ":id" ], "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/documentation/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": "If `true`, deletes the function regardless of its usage in flows.", + "key": "isForceDeletion", + "value": "false" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/:id?isForceDeletion=false", + "variable": [ { - "description": "Sort direction", - "key": "sort", + "description": "Organization ID.", + "key": "orgId", "value": "" }, { - "description": "Sort By Field", - "key": "sortBy", + "description": "Custom function ID.", + "key": "id", "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": "" - }, + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "Custom function deleted successfully.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + ":orgId", + "functions", + ":id" + ], + "query": [ { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" + "description": "If `true`, deletes the function regardless of its usage in flows.", + "key": "isForceDeletion", + "value": "false" } ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId?filter=&sort=&sortBy=&page=&pageSize=", + "raw": "{{baseUrl}}/v1/:orgId/functions/:id?isForceDeletion=false", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" + }, + { + "description": "Custom function ID.", + "key": "id", + "value": "" } ] } }, - "status": "OK" + "status": "No Content" } ] }, { - "name": "Create Template", + "name": "Import a Custom Function", "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}" + "mode": "params" }, - "description": "Creates a Profile View Template in JDS. \n\n **Role and Scope**: Requires id full admin or any role with cjp:config_write scope.\n\n **Template with single rule**: \n ```\n {\n \"name\": \"ClosedCaller\",\n \"attributes\": [\n {\n \"version\": \"0.1\",\n \"event\": \"Closed Queue\",\n \"metaDataType\": \"string\",\n \"metaData\": \"category\",\n \"limit\": 100,\n \"displayName\": \"ClosedCaller\",\n \"lookBackDurationType\": \"minutes\",\n \"lookBackPeriod\": 5,\n \"aggregationMode\": \"Count\",\n \"rules\": {\n \"logic\": \"SINGLE\",\n \"condition\": \"Closed Queue,category,string,Value EQ Closed\"\n },\n \"widgetAttributes\": {\n \"type\": \"table\"\n },\n \"verbose\": false\n }\n ]\n }\n ```\n\n\n **Example Event:** \n ```\n {\n \"id\": \"{{$guid}}\",\n \"specversion\": \"1.0\",\n \"type\": \"Closed Queue\",\n \"source\": \"Voice%20Contact\",\n \"identity\": \"jes@gmail.com\",\n \"identitytype\": \"email\",\n \"datacontenttype\": \"application/json\",\n \"data\": {\n \"Email\": \"jes@gmail.com\",\n \"CallsQueuedNow\": \"Use GetQueueInfoNode Values\",\n \"OldestCallTime\": \"Use GetQueueInfoNode Values\",\n \"LoggedOnAgents\": \"Use GetQueueInfoNode Values\",\n \"PIQ\": \"Use GetQueueInfoNode Values\",\n \"EWT\": \"Use GetQueueInfoNode Values\",\n \"category\": \"Closed\",\n \"origin\": \"Past Due - 1st Notification\",\n \"channelType\": \"QueueCall\",\n \"channelBreakout\": \"voice\"\n }\n }\n ```\n\n\n **Key components of the rule:** \n * template.event: This refers to the specific event type you want to match (e.g., \"Closed Queue\").\n * event.type: This refers to the actual event type present in the event data.\n * event.data: This is the dictionary/object containing all the metadata associated with the event.\n * template.rules.condition - category: This is the specific metadata field you want to compare within event.data.\n * template.rules.condition - string: This indicates that the category metadata is a string type.\n * template.rules.condition - Value EQ Closed: This defines the condition: the value of the category field (as a string) must be equal to \"Closed\".\n\n\n **Evaluation process:** \n 1. The rule checks if template.event matches the event.type in the incoming event.\n 2. If they match, the rule retrieves the value of the category field from event.data.\n 3. It then compares the value of category (treated as a string) to \"Closed\" using an equality operator (EQ).\n 4. If the values are equal, the condition evaluates to True and creates a progressive profile for the identity. Otherwise, it evaluates to False.\n \n The template has lookBackPeriod and lookBackDurationType which decide how long to look back for the calculation. In the above template, it fetches events triggered in the last 5 minutes and performs the aggregation mode on the data received from rules.\n \n * When the aggregation mode is Value, the profile result will have the value of the rule as the output.\n * When the aggregation mode is Count, the profile will have the count of events with category closed in the past 5 minutes.\n * When the aggregation mode is Distinct, the profile will have the value closed.\n * When aggregation mode is Sum, the data type should be Integer or double and it will be the sum of all matching values in the last 5 minutes.\n * When aggregation mode is Max, the data type should be Integer or double and it will be the max of all matching values in the last 5 minutes.\n * When aggregation mode is Min, the data type should be Integer or double and it will be the min of all matching values in the last 5 minutes.\n * When aggregation mode is Average, the data type should be Integer or double and it will be the average of all matching values in the last 5 minutes.\n\n\n **Example template with multiple rules :** \n ```\n1. {\n2. \"name\": \"sample-template-multi-condition\",\n3. \"attributes\": [\n4. {\n5. \"version\": \"0.1\",\n6. \"event\": \"Quote\",\n7. \"metaDataType\": \"string\",\n8. \"metaData\": \"email\",\n9. \"limit\": 1,\n10. \"displayName\": \"Email\",\n11. \"lookBackDurationType\": \"days\",\n12. \"lookBackPeriod\": 50,\n13. \"aggregationMode\": \"Value\",\n14. \"rules\": {\n15. \"args\": [\n16. \"Quote,isEV,string,Value EQ Yes\",\n17. \"Quote,isEV,string,Value EQ No\",\n18. {\n19. \"args\": [\n20. \"Quote,make,string,Value EQ Honda\",\n21. \"Quote,model,string,Value EQ CR-V\"\n22. ],\n23. \"logic\": \"AND\"\n24. }\n25. ],\n26. \"logic\": \"OR\"\n27. },\n28. \"widgetAttributes\": {\n29. \"type\": \"table\"\n30. },\n31. \"verbose\": false\n32. }\n33. ]\n34. }\n ```\n1. In the above template we have multiple rules.\n2. The arguments in line 20 and 21 are evaluated with logical AND condition.\n3. Then arguments in line 16 and 17 along with the result for 20 AND 21 are evaluated with logical OR (line 26).\n", + "description": "Import a custom function from a previously exported function-definition JSON file, uploaded as the multipart `file` part (not a zip or base64 envelope). Use `overwrite=true` to replace any existing function with the same name.\n\nScope: `cjp:config_write`", "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "multipart/form-data" }, { "key": "Accept", @@ -173412,18 +208293,32 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId" + ":orgId", + "functions:import" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", + "query": [ + { + "description": "If `true`, overwrites a function with the same name if one already exists.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Optional list of associated routing-context IDs.", + "key": "associatedRcs", + "value": "" + }, + { + "description": "Optional list of associated routing-context IDs.", + "key": "associatedRcs", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions:import?overwrite=false&associatedRcs=&associatedRcs=", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", + "description": "Organization ID.", + "key": "orgId", "value": "" } ] @@ -173432,8 +208327,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"200 OK\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 400, + "body": "{\n \"fnCode\": \"\",\n \"fnMetadata\": {\n \"id\": \"\",\n \"orgId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"status\": \"Published\",\n \"timeoutInSec\": \"\",\n \"tagVersionMap\": {\n \"key_0\": 7775.425818174757\n },\n \"lockedBy\": \"\",\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\"\n }\n}", + "code": 201, "cookie": [], "header": [ { @@ -173441,22 +208336,15 @@ "value": "application/json" } ], - "name": "Bad Request", + "name": "Custom function imported successfully.", "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}" + "mode": "params" }, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "multipart/form-data" }, { "key": "Accept", @@ -173469,55 +208357,49 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId" + ":orgId", + "functions:import" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", + "query": [ + { + "description": "If `true`, overwrites a function with the same name if one already exists.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Optional list of associated routing-context IDs.", + "key": "associatedRcs", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions:import?overwrite=false&associatedRcs=", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Bad Request" + "status": "Created" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Internal server error", + "header": [], + "name": "Unauthorized.", "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}" + "mode": "params" }, "header": [ { "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" + "value": "multipart/form-data" } ], "method": "POST", @@ -173526,28 +208408,38 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId" + ":orgId", + "functions:import" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", + "query": [ + { + "description": "If `true`, overwrites a function with the same name if one already exists.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Optional list of associated routing-context IDs.", + "key": "associatedRcs", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions:import?overwrite=false&associatedRcs=", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_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 \"code\": \"\",\n \"message\": \"\"\n}", + "code": 400, "cookie": [], "header": [ { @@ -173555,22 +208447,15 @@ "value": "application/json" } ], - "name": "Created", + "name": "Bad Request. The supplied function-definition file is corrupted or malformed.", "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}" + "mode": "params" }, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "multipart/form-data" }, { "key": "Accept", @@ -173583,28 +208468,38 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId" + ":orgId", + "functions:import" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", + "query": [ + { + "description": "If `true`, overwrites a function with the same name if one already exists.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Optional list of associated routing-context IDs.", + "key": "associatedRcs", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions:import?overwrite=false&associatedRcs=", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Created" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 404, + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 500, "cookie": [], "header": [ { @@ -173612,22 +208507,15 @@ "value": "application/json" } ], - "name": "Resource not found", + "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}" + "mode": "params" }, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "multipart/form-data" }, { "key": "Accept", @@ -173640,105 +208528,183 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId" + ":orgId", + "functions:import" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", + "query": [ + { + "description": "If `true`, overwrites a function with the same name if one already exists.", + "key": "overwrite", + "value": "false" + }, + { + "description": "Optional list of associated routing-context IDs.", + "key": "associatedRcs", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions:import?overwrite=false&associatedRcs=", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" } ] }, { - "name": "Get A specific Template searched by template name", + "name": "Unlock a Custom Function", "request": { - "description": "Get Template details by template Name in JDS. \n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "description": "Release the edit lock on a custom function so that other users can edit it.\n\nScope: `cjp:config_write`", "header": [ { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-name", - ":templateName" + ":orgId", + "functions", + "{{id}}:unlock" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-name/:templateName", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:unlock", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "Template Name", - "key": "templateName", + "description": "Organization ID.", + "key": "orgId", "value": "" } ] } }, "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Internal Server Error.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + ":orgId", + "functions", + "{{id}}:unlock" + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:unlock", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 401, "cookie": [], "header": [], - "name": "Internal error", + "name": "Unauthorized.", "originalRequest": { "header": [], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-name", - ":templateName" + ":orgId", + "functions", + "{{id}}:unlock" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-name/:templateName", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:unlock", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, + "description": "Organization ID.", + "key": "orgId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + ":orgId", + "functions", + "{{id}}:unlock" + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:unlock", + "variable": [ { - "description": "Template Name", - "key": "templateName" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", @@ -173746,33 +208712,26 @@ "code": 404, "cookie": [], "header": [], - "name": "Not found", + "name": "No function found for the supplied ID.", "originalRequest": { "header": [], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-name", - ":templateName" + ":orgId", + "functions", + "{{id}}:unlock" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-name/:templateName", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:unlock", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Template Name", - "key": "templateName" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } @@ -173781,7 +208740,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 \"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": [ @@ -173790,7 +208749,7 @@ "value": "application/json" } ], - "name": "Success", + "name": "Custom function unlocked successfully.", "originalRequest": { "header": [ { @@ -173798,30 +208757,23 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-name", - ":templateName" + ":orgId", + "functions", + "{{id}}:unlock" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-name/:templateName", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:unlock", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Template Name", - "key": "templateName" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } @@ -173831,46 +208783,31 @@ ] }, { - "name": "Historic Progressive Profile View by Template Name", + "name": "Lock a Custom Function", "request": { - "description": "Get Historic Progressive Profile View in JDS. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "description": "Acquire an edit lock on a custom function to prevent concurrent writes by other users.\n\nScope: `cjp:config_write`", "header": [ { "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-name", - ":templateName" + ":orgId", + "functions", + "{{id}}:lock" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:lock", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "Person ID", - "key": "personId", - "value": "" - }, - { - "description": "Template Name", - "key": "templateName", + "description": "Organization ID.", + "key": "orgId", "value": "" } ] @@ -173879,8 +208816,8 @@ "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, + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 400, "cookie": [], "header": [ { @@ -173888,7 +208825,7 @@ "value": "application/json" } ], - "name": "Ok", + "name": "Bad Request.", "originalRequest": { "header": [ { @@ -173896,45 +208833,33 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "person-id", - ":personId", - "template-name", - ":templateName" + ":orgId", + "functions", + "{{id}}:lock" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:lock", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Person ID", - "key": "personId" - }, - { - "description": "Template Name", - "key": "templateName" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "OK" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 404, + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 500, "cookie": [], "header": [ { @@ -173942,7 +208867,7 @@ "value": "application/json" } ], - "name": "Not Found", + "name": "Internal Server Error.", "originalRequest": { "header": [ { @@ -173950,35 +208875,55 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "person-id", - ":personId", - "template-name", - ":templateName" + ":orgId", + "functions", + "{{id}}:lock" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:lock", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Person ID", - "key": "personId" - }, + "description": "Organization ID.", + "key": "orgId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "No function found for the supplied ID.", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + ":orgId", + "functions", + "{{id}}:lock" + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:lock", + "variable": [ { - "description": "Template Name", - "key": "templateName" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } @@ -173987,8 +208932,8 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"200 OK\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 400, + "body": "", + "code": 200, "cookie": [], "header": [ { @@ -173996,7 +208941,7 @@ "value": "application/json" } ], - "name": "Bad Request", + "name": "Custom function locked successfully.", "originalRequest": { "header": [ { @@ -174004,138 +208949,103 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "person-id", - ":personId", - "template-name", - ":templateName" + ":orgId", + "functions", + "{{id}}:lock" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:lock", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Person ID", - "key": "personId" - }, - { - "description": "Template Name", - "key": "templateName" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Bad Request" + "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Internal server error", + "header": [], + "name": "Unauthorized.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "person-id", - ":personId", - "template-name", - ":templateName" + ":orgId", + "functions", + "{{id}}:lock" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:lock", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Person ID", - "key": "personId" - }, - { - "description": "Template Name", - "key": "templateName" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" } ] }, { - "name": "Historic Progressive Profile View", + "name": "Test a Custom Function", "request": { - "description": "Get Historic Progressive Profile View in JDS. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9451.029907400074,\n \"key_2\": 4066.9735333678545\n },\n \"key_0\": 5695.758159443376\n}" + }, + "description": "Execute a custom function with a test payload. Implicitly publishes the latest draft first, so the run uses the most recent source code.\n\nScope: `cjp:config_write`", "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" + ":orgId", + "functions", + "{{id}}:test" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:test", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "Person ID", - "key": "personId", - "value": "" - }, - { - "description": "Template ID", - "key": "templateId", + "description": "Organization ID.", + "key": "orgId", "value": "" } ] @@ -174144,8 +209054,8 @@ "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, + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": 8782\n }\n}", + "code": 500, "cookie": [], "header": [ { @@ -174153,107 +209063,102 @@ "value": "application/json" } ], - "name": "Ok", + "name": "Test invocation failed.", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9451.029907400074,\n \"key_2\": 4066.9735333678545\n },\n \"key_0\": 5695.758159443376\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", - "workspace-id", - ":workspaceId", - "person-id", - ":personId", - "template-id", - ":templateId" + ":orgId", + "functions", + "{{id}}:test" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:test", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Person ID", - "key": "personId" - }, - { - "description": "Template ID", - "key": "templateId" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "OK" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Internal server error", + "header": [], + "name": "Unauthorized.", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9451.029907400074,\n \"key_2\": 4066.9735333678545\n },\n \"key_0\": 5695.758159443376\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" + ":orgId", + "functions", + "{{id}}:test" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:test", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Person ID", - "key": "personId" - }, - { - "description": "Template ID", - "key": "templateId" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 404, + "_postman_previewlanguage": "json", + "body": "{\n \"statusCode\": \"\",\n \"data\": \"\",\n \"errorMessage\": \"\",\n \"timeTakenInMilliseconds\": \"\",\n \"key_0\": 7765,\n \"key_1\": 4562,\n \"key_2\": 7871,\n \"key_3\": true\n}", + "code": 200, "cookie": [], "header": [ { @@ -174261,52 +209166,54 @@ "value": "application/json" } ], - "name": "Not Found", + "name": "Test invocation succeeded.", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9451.029907400074,\n \"key_2\": 4066.9735333678545\n },\n \"key_0\": 5695.758159443376\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", - "workspace-id", - ":workspaceId", - "person-id", - ":personId", - "template-id", - ":templateId" + ":orgId", + "functions", + "{{id}}:test" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:test", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Person ID", - "key": "personId" - }, - { - "description": "Template ID", - "key": "templateId" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Not Found" + "status": "OK" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"200 OK\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": 8782\n }\n}", "code": 400, "cookie": [], "header": [ @@ -174315,43 +209222,45 @@ "value": "application/json" } ], - "name": "Bad Request", + "name": "Bad Request. The function ID is missing or has an invalid format.", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 9451.029907400074,\n \"key_2\": 4066.9735333678545\n },\n \"key_0\": 5695.758159443376\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", - "workspace-id", - ":workspaceId", - "person-id", - ":personId", - "template-id", - ":templateId" + ":orgId", + "functions", + "{{id}}:test" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:test", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Person ID", - "key": "personId" - }, - { - "description": "Template ID", - "key": "templateId" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } @@ -174361,46 +209270,45 @@ ] }, { - "name": "Historic Progressive Profile View By Template Name", + "name": "Publish a Custom Function", "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 \"tags\": [\n \"Test\",\n \"Live\"\n ],\n \"comment\": \"\",\n \"key_0\": 723,\n \"key_1\": 493.6300554494677,\n \"key_2\": 9380.065703526083,\n \"key_3\": 6707.369331253552\n}" + }, + "description": "Publish the latest draft of a custom function under one or more tags (`Dev`, `Test`, `Latest`, `Live`). Ensure the function has been created or updated before calling this API.\n\nScope: `cjp:config_write`", "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", - "identity", - ":identity", - "template-name", - ":templateName" + ":orgId", + "functions", + "{{id}}:publish" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:publish", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "Identity", - "key": "identity", - "value": "" - }, - { - "description": "Template Name", - "key": "templateName", + "description": "Organization ID.", + "key": "orgId", "value": "" } ] @@ -174409,8 +209317,8 @@ "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, + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 400, "cookie": [], "header": [ { @@ -174418,53 +209326,55 @@ "value": "application/json" } ], - "name": "Ok", + "name": "Bad Request. The function ID is missing or has an invalid format.", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"tags\": [\n \"Test\",\n \"Live\"\n ],\n \"comment\": \"\",\n \"key_0\": 723,\n \"key_1\": 493.6300554494677,\n \"key_2\": 9380.065703526083,\n \"key_3\": 6707.369331253552\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", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + ":orgId", + "functions", + "{{id}}:publish" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:publish", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Identity", - "key": "identity" - }, - { - "description": "Template Name", - "key": "templateName" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "OK" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 404, + "body": "{\n \"fnCode\": \"\",\n \"fnMetadata\": {\n \"id\": \"\",\n \"orgId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"language\": \"js\",\n \"selectedRuntime\": \"\",\n \"status\": \"Published\",\n \"timeoutInSec\": \"\",\n \"tagVersionMap\": {\n \"key_0\": 7775.425818174757\n },\n \"lockedBy\": \"\",\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\"\n }\n}", + "code": 200, "cookie": [], "header": [ { @@ -174472,106 +209382,101 @@ "value": "application/json" } ], - "name": "Not Found", + "name": "Custom function published successfully.", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"tags\": [\n \"Test\",\n \"Live\"\n ],\n \"comment\": \"\",\n \"key_0\": 723,\n \"key_1\": 493.6300554494677,\n \"key_2\": 9380.065703526083,\n \"key_3\": 6707.369331253552\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", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + ":orgId", + "functions", + "{{id}}:publish" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:publish", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Identity", - "key": "identity" - }, - { - "description": "Template Name", - "key": "templateName" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Not Found" + "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"200 OK\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Bad Request", + "header": [], + "name": "Unauthorized.", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"tags\": [\n \"Test\",\n \"Live\"\n ],\n \"comment\": \"\",\n \"key_0\": 723,\n \"key_1\": 493.6300554494677,\n \"key_2\": 9380.065703526083,\n \"key_3\": 6707.369331253552\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" + ":orgId", + "functions", + "{{id}}:publish" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:publish", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Identity", - "key": "identity" - }, - { - "description": "Template Name", - "key": "templateName" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Bad Request" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "code": 500, "cookie": [], "header": [ @@ -174580,43 +209485,45 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Publish failed.", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"tags\": [\n \"Test\",\n \"Live\"\n ],\n \"comment\": \"\",\n \"key_0\": 723,\n \"key_1\": 493.6300554494677,\n \"key_2\": 9380.065703526083,\n \"key_3\": 6707.369331253552\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", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + ":orgId", + "functions", + "{{id}}:publish" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:publish", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Identity", - "key": "identity" - }, - { - "description": "Template Name", - "key": "templateName" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } @@ -174626,46 +209533,38 @@ ] }, { - "name": "Historic Progressive Profile View By Template Id", + "name": "Export a Custom Function", "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", + "description": "Export a custom function for the given version or publish tag. Returns the plain function-definition JSON (name, language, runtime, description, source code, inputs, and outputs), suitable for re-importing via the import API.\n\nScope: `cjp:config_read`", "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-id", - ":templateId" + ":orgId", + "functions", + "{{id}}:export" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", - "variable": [ - { - "description": "Workspace ID", - "key": "workspaceId", - "value": "" - }, + "query": [ { - "description": "identity", - "key": "identity", + "description": "Version number or publish tag of the source code to export. If omitted, the latest published version is exported.", + "key": "versionOrTag", "value": "" - }, + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:export?versionOrTag=", + "variable": [ { - "description": "Template ID", - "key": "templateId", + "description": "Organization ID.", + "key": "orgId", "value": "" } ] @@ -174674,8 +209573,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 500, + "body": "{\n \"name\": \"\",\n \"language\": \"\",\n \"runtime\": \"\",\n \"description\": \"\",\n \"sourceCode\": \"\",\n \"inputs\": [\n {\n \"key_0\": 9498,\n \"key_1\": \"string\"\n },\n {\n \"key_0\": 2807,\n \"key_1\": 6746.94732913891\n }\n ],\n \"outputs\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { @@ -174683,7 +209582,7 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Export succeeded.", "originalRequest": { "header": [ { @@ -174691,44 +209590,39 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + ":orgId", + "functions", + "{{id}}:export" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", - "variable": [ - { - "description": "Workspace ID", - "key": "workspaceId" - }, + "query": [ { - "description": "identity", - "key": "identity" - }, + "description": "Version number or publish tag of the source code to export. If omitted, the latest published version is exported.", + "key": "versionOrTag", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:export?versionOrTag=", + "variable": [ { - "description": "Template ID", - "key": "templateId" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"200 OK\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "code": 400, "cookie": [], "header": [ @@ -174737,7 +209631,7 @@ "value": "application/json" } ], - "name": "Bad Request", + "name": "Bad Request. The function ID has an invalid format.", "originalRequest": { "header": [ { @@ -174745,35 +209639,30 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + ":orgId", + "functions", + "{{id}}:export" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", - "variable": [ - { - "description": "Workspace ID", - "key": "workspaceId" - }, + "query": [ { - "description": "identity", - "key": "identity" - }, + "description": "Version number or publish tag of the source code to export. If omitted, the latest published version is exported.", + "key": "versionOrTag", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:export?versionOrTag=", + "variable": [ { - "description": "Template ID", - "key": "templateId" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } @@ -174781,63 +209670,48 @@ "status": "Bad Request" }, { - "_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": "Unauthorized.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + ":orgId", + "functions", + "{{id}}:export" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", - "variable": [ - { - "description": "Workspace ID", - "key": "workspaceId" - }, + "query": [ { - "description": "identity", - "key": "identity" - }, + "description": "Version number or publish tag of the source code to export. If omitted, the latest published version is exported.", + "key": "versionOrTag", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:export?versionOrTag=", + "variable": [ { - "description": "Template ID", - "key": "templateId" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 404, + "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", + "code": 500, "cookie": [], "header": [ { @@ -174845,7 +209719,7 @@ "value": "application/json" } ], - "name": "Not Found", + "name": "Export failed.", "originalRequest": { "header": [ { @@ -174853,47 +209727,42 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + ":orgId", + "functions", + "{{id}}:export" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", - "variable": [ - { - "description": "Workspace ID", - "key": "workspaceId" - }, + "query": [ { - "description": "identity", - "key": "identity" - }, + "description": "Version number or publish tag of the source code to export. If omitted, the latest published version is exported.", + "key": "versionOrTag", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/{{id}}:export?versionOrTag=", + "variable": [ { - "description": "Template ID", - "key": "templateId" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" } ] }, { - "name": "Stream Progressive profile Views By Template Name", + "name": "List Function Options", "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. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "description": "List the supported programming languages, runtimes, and corresponding wrapper code for custom functions. Filter by `language` or `runtime` to narrow the result.\n\nScope: `cjp:config_read`", "header": [ { "key": "Accept", @@ -174907,31 +209776,27 @@ ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + ":orgId", + "functions", + "options" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId", + "description": "Filter by programming language (for example, `js`, `py`).", + "key": "language", "value": "" }, { - "description": "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", + "description": "Filter by runtime (for example, `nodejs22.x`, `python3.13`).", + "key": "runtime", "value": "" - }, + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/options?language=&runtime=", + "variable": [ { - "description": "Template Name", - "key": "templateName", + "description": "Organization ID.", + "key": "orgId", "value": "" } ] @@ -174940,8 +209805,8 @@ "response": [ { "_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, + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": 4225\n },\n \"key_0\": 9104.234255149828,\n \"key_1\": false,\n \"key_2\": 8464.995796328034,\n \"key_3\": false\n}", + "code": 500, "cookie": [], "header": [ { @@ -174949,7 +209814,7 @@ "value": "application/json" } ], - "name": "Ok", + "name": "Internal Server Error.", "originalRequest": { "header": [ { @@ -174964,39 +209829,38 @@ ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + ":orgId", + "functions", + "options" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Filter by programming language (for example, `js`, `py`).", + "key": "language", + "value": "" }, { - "description": "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" - }, + "description": "Filter by runtime (for example, `nodejs22.x`, `python3.13`).", + "key": "runtime", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/options?language=&runtime=", + "variable": [ { - "description": "Template Name", - "key": "templateName" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 429, + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": 4225\n },\n \"key_0\": 9104.234255149828,\n \"key_1\": false,\n \"key_2\": 8464.995796328034,\n \"key_3\": false\n}", + "code": 400, "cookie": [], "header": [ { @@ -175004,7 +209868,7 @@ "value": "application/json" } ], - "name": "Too many requests", + "name": "Bad Request.", "originalRequest": { "header": [ { @@ -175019,54 +209883,43 @@ ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + ":orgId", + "functions", + "options" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Filter by programming language (for example, `js`, `py`).", + "key": "language", + "value": "" }, { - "description": "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" - }, + "description": "Filter by runtime (for example, `nodejs22.x`, `python3.13`).", + "key": "runtime", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/options?language=&runtime=", + "variable": [ { - "description": "Template Name", - "key": "templateName" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": null, + "code": 404, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Internal server error", + "header": [], + "name": "No data found matching the supplied filters.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -175074,39 +209927,38 @@ ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + ":orgId", + "functions", + "options" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Filter by programming language (for example, `js`, `py`).", + "key": "language", + "value": "" }, { - "description": "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" - }, + "description": "Filter by runtime (for example, `nodejs22.x`, `python3.13`).", + "key": "runtime", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/options?language=&runtime=", + "variable": [ { - "description": "Template Name", - "key": "templateName" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 409, + "body": "{\n \"languages\": [\n {\n \"language\": \"\",\n \"runtimes\": [\n \"\",\n \"\"\n ],\n \"wrapperCode\": \"\"\n },\n {\n \"language\": \"\",\n \"runtimes\": [\n \"\",\n \"\"\n ],\n \"wrapperCode\": \"\",\n \"key_0\": 8585\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": 9117\n}", + "code": 200, "cookie": [], "header": [ { @@ -175114,7 +209966,7 @@ "value": "application/json" } ], - "name": "Resource already exists", + "name": "Options retrieved successfully.", "originalRequest": { "header": [ { @@ -175129,54 +209981,43 @@ ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + ":orgId", + "functions", + "options" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Filter by programming language (for example, `js`, `py`).", + "key": "language", + "value": "" }, { - "description": "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" - }, + "description": "Filter by runtime (for example, `nodejs22.x`, `python3.13`).", + "key": "runtime", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/options?language=&runtime=", + "variable": [ { - "description": "Template Name", - "key": "templateName" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Conflict" + "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ @@ -175184,41 +210025,45 @@ ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + ":orgId", + "functions", + "options" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Filter by programming language (for example, `js`, `py`).", + "key": "language", + "value": "" }, { - "description": "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" - }, + "description": "Filter by runtime (for example, `nodejs22.x`, `python3.13`).", + "key": "runtime", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/:orgId/functions/options?language=&runtime=", + "variable": [ { - "description": "Template Name", - "key": "templateName" + "description": "Organization ID.", + "key": "orgId", + "value": "" } ] } }, - "status": "Not Found" + "status": "Unauthorized" } ] - }, + } + ], + "name": "Functions" + }, + { + "item": [ { - "name": "Stream Progressive profile Views By Template Id", + "name": "Export a Flow or Subflow", "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. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "description": "**Deprecated.** Use the Flow export endpoint (`GET /flow-store/{orgId}/project/{projectId}/v2/flows/{flowId}:export`, operationId `exportFlowV2`) instead. The V1 Flow APIs operate on the raw FDL format and will continue to function but will not receive new features.\n\nReturns the exported flow/subflow in response, including associated channel metadata used to preserve channel-specific activity behavior during export and re-import.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", "header": [ { "key": "Accept", @@ -175231,32 +210076,35 @@ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:export" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", - "variable": [ + "query": [ { - "description": "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" }, { - "description": "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", + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:export?version=latest&flowType=FLOW", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId", "value": "" }, { - "description": "Template ID", - "key": "templateId", + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", "value": "" } ] @@ -175264,109 +210112,50 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:export" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", - "variable": [ - { - "description": "Workspace ID", - "key": "workspaceId" - }, + "query": [ { - "description": "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" + "description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.", + "key": "version", + "value": "latest" }, { - "description": "Template ID", - "key": "templateId" + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" } - ] - } - }, - "status": "Internal Server Error" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:export?version=latest&flowType=FLOW", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "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" + "description": "Organization ID.", + "key": "orgId", + "value": "" }, { - "description": "Template ID", - "key": "templateId" + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", + "value": "" } ] } @@ -175374,63 +210163,59 @@ "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource already exists", + "header": [], + "name": "Unauthorized", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:export" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.", + "key": "version", + "value": "latest" }, { - "description": "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" + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:export?version=latest&flowType=FLOW", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId", + "value": "" }, { - "description": "Template ID", - "key": "templateId" + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", + "value": "" } ] } }, - "status": "Conflict" + "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}", + "body": "{\n \"associatedChannels\": [\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\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 \"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 \"key_2\": {\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 },\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 \"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}", "code": 200, "cookie": [], "header": [ @@ -175439,7 +210224,7 @@ "value": "application/json" } ], - "name": "Ok", + "name": "OK", "originalRequest": { "header": [ { @@ -175453,30 +210238,36 @@ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:export" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.", + "key": "version", + "value": "latest" }, { - "description": "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" + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:export?version=latest&flowType=FLOW", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId", + "value": "" }, { - "description": "Template ID", - "key": "templateId" + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", + "value": "" } ] } @@ -175484,126 +210275,114 @@ "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests", + "header": [], + "name": "Forbidden", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:export" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.", + "key": "version", + "value": "latest" }, { - "description": "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" + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:export?version=latest&flowType=FLOW", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId", + "value": "" }, { - "description": "Template ID", - "key": "templateId" + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" } ] }, { - "name": "Historic Journey Events", + "name": "Import a Flow or Subflow", "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. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "body": { + "mode": "params" + }, + "description": "**Deprecated.** Use the Flow import endpoint (`POST /flow-store/{orgId}/project/{projectId}/v2/flows:import`, operationId `importFlowV2`) instead. The V1 Flow APIs operate on the raw FDL format and will continue to function but will not receive new features.\n\nReturns 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": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "events", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows:import" ], "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/documentation/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": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", + "key": "overwrite", "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/documentation/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": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", "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=", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "variable": [ { - "description": "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": "" } ] @@ -175612,8 +210391,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 500, + "body": "{\n \"associatedChannels\": [\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"channelType\": \"\",\n \"id\": \"\",\n \"name\": \"\"\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}", + "code": 201, "cookie": [], "header": [ { @@ -175621,396 +210400,456 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "CREATED: Flow or Subflow is created.", "originalRequest": { + "body": { + "mode": "params" + }, "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": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "events", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows:import" ], "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", + "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", + "key": "overwrite", "value": "" }, { - "description": "sort direction", - "key": "sort", + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", "value": "" - }, + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", + "variable": [ { - "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/documentation/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": "Organization ID.", + "key": "orgId", "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/documentation/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": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", "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": "Workspace ID", - "key": "workspaceId" } ] } }, - "status": "Internal Server Error" + "status": "Created" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": null, + "code": 409, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests", + "header": [], + "name": "CONFLICT: A flow/subflow with the same name already exists.", "originalRequest": { + "body": { + "mode": "params" + }, "header": [ { - "key": "Accept", - "value": "application/json" + "description": "Content length value in number of bytes.", + "key": "Content-Length", + "value": "" + }, + { + "key": "Content-Type", + "value": "multipart/form-data" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "events", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows:import" ], "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", + "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", + "key": "overwrite", "value": "" }, { - "description": "sort direction", - "key": "sort", + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", "value": "" - }, + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", + "variable": [ { - "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/documentation/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": "Organization ID.", + "key": "orgId", "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/documentation/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": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", "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": "Workspace ID", - "key": "workspaceId" } ] } }, - "status": "Too Many Requests" + "status": "Conflict" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource already exists", + "header": [], + "name": "Unauthorized", "originalRequest": { + "body": { + "mode": "params" + }, "header": [ { - "key": "Accept", - "value": "application/json" + "description": "Content length value in number of bytes.", + "key": "Content-Length", + "value": "" + }, + { + "key": "Content-Type", + "value": "multipart/form-data" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "events", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows:import" ], "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", + "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", + "key": "overwrite", "value": "" }, { - "description": "sort direction", - "key": "sort", + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", "value": "" - }, + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", + "variable": [ { - "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/documentation/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": "Organization ID.", + "key": "orgId", "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/documentation/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": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", "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": "Workspace ID", - "key": "workspaceId" } ] } }, - "status": "Conflict" + "status": "Unauthorized" }, { - "_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": { + "body": { + "mode": "params" + }, "header": [ { - "key": "Accept", - "value": "application/json" + "description": "Content length value in number of bytes.", + "key": "Content-Length", + "value": "" + }, + { + "key": "Content-Type", + "value": "multipart/form-data" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "events", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows:import" ], "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", + "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", + "key": "overwrite", "value": "" }, { - "description": "sort By Field", - "key": "sortBy", + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", "value": "" - }, + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", + "variable": [ { - "description": "sort direction", - "key": "sort", + "description": "Organization ID.", + "key": "orgId", "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/documentation/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": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", "value": "" - }, + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error", + "originalRequest": { + "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": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows:import" + ], + "query": [ { - "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/documentation/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": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", + "key": "overwrite", "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": "" + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "" } ], - "raw": "{{baseUrl}}/v1/api/events/workspace-id/:workspaceId?identity=&sortBy=&sort=&filter=&data=&page=&pageSize=", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "variable": [ { - "description": "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": "" } ] } }, - "status": "OK" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": "params" + }, "header": [ { - "key": "Accept", - "value": "application/json" + "description": "Content length value in number of bytes.", + "key": "Content-Length", + "value": "" + }, + { + "key": "Content-Type", + "value": "multipart/form-data" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "events", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows:import" ], "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", + "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", + "key": "overwrite", "value": "" }, { - "description": "sort By Field", - "key": "sortBy", + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", "value": "" - }, + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", + "variable": [ { - "description": "sort direction", - "key": "sort", + "description": "Organization ID.", + "key": "orgId", "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/documentation/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": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", "value": "" - }, + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "BAD REQUEST: Possible causes - Import file size exceeded the limit. File parse error. Flow name is empty. Invalid flow type. Invalid activity.", + "originalRequest": { + "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": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows:import" + ], + "query": [ { - "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/documentation/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": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", + "key": "overwrite", "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": "" + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "" } ], - "raw": "{{baseUrl}}/v1/api/events/workspace-id/:workspaceId?identity=&sortBy=&sort=&filter=&data=&page=&pageSize=", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "variable": [ { - "description": "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": "" } ] } }, - "status": "Not Found" + "status": "Bad Request" } ] - }, + } + ], + "name": "Legacy Flows" + }, + { + "item": [ { - "name": "Stream Events By Identity", + "name": "List Flow Templates", "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. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.", + "description": "List available flow templates that can be used to create new flows.\n\nScope: `cjp:config_read`", "header": [ { "key": "Accept", @@ -176023,37 +210862,30 @@ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "events", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity" + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "templates" ], "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/documentation/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/documentation/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": "Filter by flow or subflow.", + "key": "type", + "value": "subflow" } ], - "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/templates?type=subflow", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", + "description": "Organization ID.", + "key": "orgId", "value": "" }, { - "description": "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", + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", "value": "" } ] @@ -176061,69 +210893,54 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found", + "header": [], + "name": "Forbidden.", "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", + "v2", + "templates" ], "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/documentation/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/documentation/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": "Filter by flow or subflow.", + "key": "type", + "value": "subflow" } ], - "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/templates?type=subflow", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" }, { - "description": "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" + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", + "value": "" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_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}", + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"subflow\",\n \"flow\": {\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Published\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false\n },\n \"outputs\": {\n \"key_0\": 8344,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 589,\n \"key_1\": 9290.037128020544\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 300,\n \"key_2\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 303.74464645250174,\n \"key_1\": 3249.8532193564024\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 6900,\n \"key_1\": false\n },\n \"outputs\": {\n \"key_0\": 2957.7040980822876\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": false\n },\n \"outputs\": {\n \"key_0\": 6904.3757741874015,\n \"key_1\": 3730.21560168032\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 8051.662494519798\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": true\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 6737,\n \"key_1\": 7401\n },\n \"outputs\": {\n \"key_0\": 1238.5486442315696\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 6678,\n \"key_1\": 9877\n },\n \"outputs\": {\n \"key_0\": true,\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n }\n ],\n \"key_0\": false,\n \"key_1\": 5459.546779169584,\n \"key_2\": 1820\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": false,\n \"key_1\": 8740.830531869324\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"flow\",\n \"flow\": {\n \"flowName\": \"\",\n \"flowType\": \"SUBFLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 3674.678735898238,\n \"key_1\": 9512\n },\n \"outputs\": {\n \"key_0\": false,\n \"key_1\": 9202\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 835.4298294176243\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 9783\n },\n \"outputs\": {\n \"key_0\": 3203,\n \"key_1\": true,\n \"key_2\": \"string\",\n \"key_3\": 8711\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true,\n \"key_1\": 7758,\n \"key_2\": 1903,\n \"key_3\": false\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 45.20476200376544\n },\n \"outputs\": {\n \"key_0\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 9976.210349348767,\n \"key_1\": 4339.37755058736\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 7101,\n \"key_3\": 1939,\n \"key_4\": 8225\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": true\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 1741,\n \"key_1\": true\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n]", "code": 200, "cookie": [], "header": [ @@ -176132,7 +210949,7 @@ "value": "application/json" } ], - "name": "Ok", + "name": "Array of template metadata with IDs, names, and descriptions.", "originalRequest": { "header": [ { @@ -176146,36 +210963,31 @@ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "events", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity" + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "templates" ], "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/documentation/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/documentation/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": "Filter by flow or subflow.", + "key": "type", + "value": "subflow" } ], - "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/templates?type=subflow", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" }, { - "description": "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" + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", + "value": "" } ] } @@ -176183,121 +210995,91 @@ "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Internal server error", + "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", + "v2", + "templates" ], "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/documentation/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/documentation/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": "Filter by flow or subflow.", + "key": "type", + "value": "subflow" } ], - "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/templates?type=subflow", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" }, { - "description": "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" + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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.", "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", + "v2", + "templates" ], "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/documentation/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/documentation/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": "Filter by flow or subflow.", + "key": "type", + "value": "subflow" } ], - "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/templates?type=subflow", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" }, { - "description": "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" + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", + "value": "" } ] } @@ -176305,77 +211087,57 @@ "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity" + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "templates" ], "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/documentation/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/documentation/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": "Filter by flow or subflow.", + "key": "type", + "value": "subflow" } ], - "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/templates?type=subflow", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId", + "value": "" }, { - "description": "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" + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", + "value": "" } ] } }, - "status": "Conflict" + "status": "Not Found" } ] - } - ], - "name": "Journey - Profile Creation & Insights API" - }, - { - "item": [ + }, { - "name": "Get WXCC Subscription", + "name": "Get a Flow Template", "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": "Retrieve a specific flow template by its ID. Use this to inspect a template's flow structure before creating a flow from it.\n\nScope: `cjp:config_read`", "header": [ { "key": "Accept", @@ -176388,18 +211150,29 @@ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "templates", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/templates/:id", "variable": [ { - "description": "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": "" + }, + { + "description": "Template ID.", + "key": "id", "value": "" } ] @@ -176407,138 +211180,144 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": null, + "code": 429, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found", + "header": [], + "name": "Too Many Requests.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "templates", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/templates/:id", "variable": [ { - "description": "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": "" + }, + { + "description": "Template ID.", + "key": "id", + "value": "" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": null, + "code": 404, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests", + "header": [], + "name": "Not Found.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "templates", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/templates/:id", "variable": [ { - "description": "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": "" + }, + { + "description": "Template ID.", + "key": "id", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { - "_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, + "_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": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "templates", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/templates/:id", "variable": [ { - "description": "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": "" + }, + { + "description": "Template ID.", + "key": "id", + "value": "" } ] } }, - "status": "OK" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 500, + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"subflow\",\n \"flow\": {\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Published\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"outputs\": {\n \"key_0\": 8779,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 7835\n },\n \"outputs\": {\n \"key_0\": 6054,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": false,\n \"key_1\": 8507.226261638336,\n \"key_2\": false,\n \"key_3\": 9625.350325447922\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": \"string\",\n \"key_1\": 53.202665580915905,\n \"key_2\": 3338\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 9303.43993051901,\n \"key_1\": true\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 6705.147477211155\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 4569.611597640395\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": 4416\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3919\n }\n ],\n \"key_0\": 6713\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 7810,\n \"key_1\": 7255.387745545414\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 5442.634092100227\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": true\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 3819\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 3179,\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": 7999\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": 1572.2500529478855\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 9474.260271228135,\n \"key_1\": 1479\n }\n ]\n },\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}", + "code": 200, "cookie": [], "header": [ { @@ -176546,7 +211325,7 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Template metadata and flow structure.", "originalRequest": { "header": [ { @@ -176560,236 +211339,203 @@ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "templates", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/templates/:id", "variable": [ { - "description": "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": "" + }, + { + "description": "Template ID.", + "key": "id", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource already exists", + "header": [], + "name": "Unauthorized.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "v2", + "templates", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/v2/templates/:id", "variable": [ { - "description": "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": "" + }, + { + "description": "Template ID.", + "key": "id", + "value": "" } ] } }, - "status": "Conflict" + "status": "Unauthorized" } ] }, { - "name": "Create WXCC Subscription", + "name": "List Flow Templates", "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", + "description": "List available flow templates that can be used to create new flows.\n\nScope: `cjp:config_read`", "header": [ { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "templates" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId", - "value": "" + "description": "Filter by flow or subflow.", + "key": "type", + "value": "subflow" } - ] + ], + "raw": "{{baseUrl}}/templates?type=subflow" } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "templates" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Filter by flow or subflow.", + "key": "type", + "value": "subflow" } - ] + ], + "raw": "{{baseUrl}}/templates?type=subflow" } }, - "status": "Internal Server Error" + "status": "Not Found" }, { - "_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": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Created", + "header": [], + "name": "Forbidden.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "templates" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Filter by flow or subflow.", + "key": "type", + "value": "subflow" } - ] + ], + "raw": "{{baseUrl}}/templates?type=subflow" } }, - "status": "Created" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": null, + "code": 429, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found", + "header": [], + "name": "Too Many Requests.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "templates" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Filter by flow or subflow.", + "key": "type", + "value": "subflow" } - ] + ], + "raw": "{{baseUrl}}/templates?type=subflow" } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 429, + "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"flow\",\n \"flow\": {\n \"flowName\": \"\",\n \"flowType\": \"SUBFLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 1302\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 3044.6479005658002\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8997.585704942077,\n \"key_1\": 2184.257860339507,\n \"key_2\": \"string\",\n \"key_3\": 649.2623223658867\n },\n \"outputs\": {\n \"key_0\": true,\n \"key_1\": 9962.227687113538\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 8624.692697742868,\n \"key_1\": true\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": false\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 7225\n },\n \"outputs\": {\n \"key_0\": 1090,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": true,\n \"key_3\": true\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 7000.812922825919,\n \"key_1\": 3130,\n \"key_2\": 5148,\n \"key_3\": 3945.909770167204\n },\n \"outputs\": {\n \"key_0\": true,\n \"key_1\": false,\n \"key_2\": false,\n \"key_3\": 7774.403299637172\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 657.7737652330451\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 8999.418813110582,\n \"key_1\": 8315\n },\n \"outputs\": {\n \"key_0\": 7627.961021955112,\n \"key_1\": true\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ]\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 3135.267559954058\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 7317,\n \"key_1\": \"string\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"subflow\",\n \"flow\": {\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Published\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 9440,\n \"key_1\": 7013\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 7151.557797315391\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": \"string\",\n \"key_1\": 6534.595877781073,\n \"key_2\": 5090.168928130339\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": true\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 5959,\n \"key_3\": true,\n \"key_4\": 166.64269693069446\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 6661.262732145426,\n \"key_1\": 3002,\n \"key_2\": 3550,\n \"key_3\": 2397\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 6417.297642181392\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 7329.315804963739\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": 5695.079582815779,\n \"key_1\": \"string\",\n \"key_2\": false\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": true,\n \"key_1\": 8316.669382446065\n },\n \"outputs\": {\n \"key_0\": 5758,\n \"key_1\": 8099.940033965731\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 3147.3040015020892,\n \"key_1\": \"string\"\n },\n \"outputs\": {\n \"key_0\": 4396.845315494919,\n \"key_1\": true\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": \"string\"\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\",\n \"key_0\": 8262\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": \"string\"\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n]", + "code": 200, "cookie": [], "header": [ { @@ -176797,7 +211543,7 @@ "value": "application/json" } ], - "name": "Too many requests", + "name": "Array of template metadata with IDs, names, and descriptions.", "originalRequest": { "header": [ { @@ -176805,103 +211551,81 @@ "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "templates" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Filter by flow or subflow.", + "key": "type", + "value": "subflow" } - ] + ], + "raw": "{{baseUrl}}/templates?type=subflow" } }, - "status": "Too Many Requests" + "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource already exists", + "header": [], + "name": "Unauthorized.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "templates" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Filter by flow or subflow.", + "key": "type", + "value": "subflow" } - ] + ], + "raw": "{{baseUrl}}/templates?type=subflow" } }, - "status": "Conflict" + "status": "Unauthorized" } ] }, { - "name": "Delete WXCC Subscription", + "name": "Get a Flow Template", "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", + "description": "Retrieve a specific flow template by its ID. Use this to inspect a template's flow structure before creating a flow from it.\n\nScope: `cjp:config_read`", "header": [ { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "templates", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/templates/:id", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", + "description": "Template ID.", + "key": "id", "value": "" } ] @@ -176909,52 +211633,39 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests", + "header": [], + "name": "Forbidden.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "DELETE", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "templates", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/templates/:id", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Template ID.", + "key": "id", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 500, + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"type\": \"subflow\",\n \"flow\": {\n \"flowName\": \"\",\n \"flowType\": \"FLOW\",\n \"contactType\": \"\",\n \"description\": \"\",\n \"version\": \"\",\n \"status\": \"Draft\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 4031,\n \"key_1\": true\n },\n \"outputs\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": false\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": 320,\n \"key_1\": 4083.4523241429974\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 9429\n },\n \"outputs\": {\n \"key_0\": 4771\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"key_0\": 2517,\n \"key_1\": false,\n \"key_2\": 6128.449923846691,\n \"key_3\": true\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"description\": \"\",\n \"isCAD\": \"\",\n \"isAgentEditable\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\"\n }\n ],\n \"eventFlows\": [\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 3782\n },\n \"outputs\": {\n \"key_0\": 7403,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": \"string\"\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\"\n },\n \"outputs\": {\n \"key_0\": false,\n \"key_1\": 4063.725798959212,\n \"key_2\": 5356\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": 7736,\n \"key_1\": \"string\"\n },\n {\n \"event\": \"\",\n \"nodes\": [\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 7559.881144076868,\n \"key_2\": false\n },\n \"outputs\": {\n \"key_0\": 2363,\n \"key_1\": \"string\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"key_0\": \"string\"\n },\n {\n \"name\": \"\",\n \"activityName\": \"\",\n \"inputs\": {\n \"key_0\": 4598,\n \"key_1\": 1120,\n \"key_2\": 5672\n },\n \"outputs\": {\n \"key_0\": 3681\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n }\n ],\n \"edges\": [\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n },\n {\n \"key\": \"\",\n \"from_node\": \"\",\n \"from_port\": \"\",\n \"to_node\": \"\",\n \"condition\": \"\"\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": true\n }\n ],\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\",\n \"key_0\": 4883\n }\n ]\n }\n}", + "code": 200, "cookie": [], "header": [ { @@ -176962,7 +211673,7 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Template metadata and flow structure.", "originalRequest": { "header": [ { @@ -176970,170 +211681,129 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "templates", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/templates/:id", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Template ID.", + "key": "id", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": null, + "code": 429, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found", + "header": [], + "name": "Too Many Requests.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "DELETE", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "templates", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/templates/:id", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Template ID.", + "key": "id", + "value": "" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource already exists", + "header": [], + "name": "Unauthorized.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "DELETE", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "templates", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/templates/:id", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Template ID.", + "key": "id", + "value": "" } ] } }, - "status": "Conflict" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 404, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "No Content", + "header": [], + "name": "Not Found.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "DELETE", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" + "templates", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/templates/:id", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "Template ID.", + "key": "id", + "value": "" } ] } }, - "status": "OK" + "status": "Not Found" } ] } ], - "name": "Journey - Subscription API" + "name": "Templates" }, { + "description": "Operations for retrieving campaigns associated with a campaign group", "item": [ { - "name": "Get all Journey Actions", + "name": "List Campaigns by Campaign Group", "request": { - "description": "Get all Journey Actions in JDS. \n\nRole and Scope: Requires id full admin or any role with cjp:config_write or cjp:config_read scope.", + "description": "Retrieves the list of campaigns that belong to the specified campaign group. Results are paginated and can optionally be filtered by campaign status.\n\n**Note:** The `campaignStatus` filter is case-insensitive. Allowed values are `Draft`, `Running`, `Pending`, `Paused`, `Completed`, `Ended`. Unknown values will result in a 400 response.", "header": [ { "key": "Accept", @@ -177146,41 +211816,35 @@ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId" + "v3", + "campaign-management", + "campaign-groups", + ":campaignGroupName", + "campaigns" ], "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.", + "description": "The page number of the result set to retrieve (1-based).", "key": "page", - "value": "" + "value": "1" }, { - "description": "Number of items to be displayed on a page.", + "description": "The number of campaigns to return per page. Must be between 1 and 100.", "key": "pageSize", - "value": "" + "value": "50" + }, + { + "description": "Optional filter for campaign status. Case-insensitive. Allowed values: `Draft`, `Running`, `Pending`, `Paused`, `Completed`, `Ended`.", + "key": "campaignStatus", + "value": "Ended" } ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId?sortBy=&sort=&page=&pageSize=", + "raw": "{{baseUrl}}/v3/campaign-management/campaign-groups/:campaignGroupName/campaigns?page=1&pageSize=50&campaignStatus=Ended", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", - "value": "" + "description": "The name of the campaign group whose campaigns are to be retrieved. Case-insensitive matching.\n\n **Allowed characters:** - `A-Z`, `a-z`, `0-9`, `_` (underscore), space \n**Allowed Length** `1..64`", + "key": "campaignGroupName", + "value": "9gqgOyRzjRAWH_xdn0U624PohBst648V_wh8zKGOci aAwyqAj d6X_qy" } ] } @@ -177188,8 +211852,8 @@ "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}", - "code": 200, + "body": "{\n \"code\": 502,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 502, "cookie": [], "header": [ { @@ -177197,7 +211861,7 @@ "value": "application/json" } ], - "name": "Success", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [ { @@ -177211,203 +211875,165 @@ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId" + "v3", + "campaign-management", + "campaign-groups", + ":campaignGroupName", + "campaigns" ], "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.", + "description": "The page number of the result set to retrieve (1-based).", "key": "page", - "value": "" + "value": "1" }, { - "description": "Number of items to be displayed on a page.", + "description": "The number of campaigns to return per page. Must be between 1 and 100.", "key": "pageSize", - "value": "" + "value": "50" + }, + { + "description": "Optional filter for campaign status. Case-insensitive. Allowed values: `Draft`, `Running`, `Pending`, `Paused`, `Completed`, `Ended`.", + "key": "campaignStatus", + "value": "Ended" } ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId?sortBy=&sort=&page=&pageSize=", + "raw": "{{baseUrl}}/v3/campaign-management/campaign-groups/:campaignGroupName/campaigns?page=1&pageSize=50&campaignStatus=Ended", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "The name of the campaign group whose campaigns are to be retrieved. Case-insensitive matching.\n\n **Allowed characters:** - `A-Z`, `a-z`, `0-9`, `_` (underscore), space \n**Allowed Length** `1..64`", + "key": "campaignGroupName", + "value": "9gqgOyRzjRAWH_xdn0U624PohBst648V_wh8zKGOci aAwyqAj d6X_qy" } ] } }, - "status": "OK" + "status": "Bad Gateway" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 400, "cookie": [], - "header": [], - "name": "Internal error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request: The request was invalid (e.g., invalid `page`, `pageSize`, or `campaignStatus`).", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId" + "v3", + "campaign-management", + "campaign-groups", + ":campaignGroupName", + "campaigns" ], "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.", + "description": "The page number of the result set to retrieve (1-based).", "key": "page", - "value": "" + "value": "1" }, { - "description": "Number of items to be displayed on a page.", + "description": "The number of campaigns to return per page. Must be between 1 and 100.", "key": "pageSize", - "value": "" + "value": "50" + }, + { + "description": "Optional filter for campaign status. Case-insensitive. Allowed values: `Draft`, `Running`, `Pending`, `Paused`, `Completed`, `Ended`.", + "key": "campaignStatus", + "value": "Ended" } ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId?sortBy=&sort=&page=&pageSize=", + "raw": "{{baseUrl}}/v3/campaign-management/campaign-groups/:campaignGroupName/campaigns?page=1&pageSize=50&campaignStatus=Ended", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "The name of the campaign group whose campaigns are to be retrieved. Case-insensitive matching.\n\n **Allowed characters:** - `A-Z`, `a-z`, `0-9`, `_` (underscore), space \n**Allowed Length** `1..64`", + "key": "campaignGroupName", + "value": "9gqgOyRzjRAWH_xdn0U624PohBst648V_wh8zKGOci aAwyqAj d6X_qy" } ] } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 404, + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 500, "cookie": [], - "header": [], - "name": "Not found", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "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": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId" + "v3", + "campaign-management", + "campaign-groups", + ":campaignGroupName", + "campaigns" ], "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.", + "description": "The page number of the result set to retrieve (1-based).", "key": "page", - "value": "" + "value": "1" }, { - "description": "Number of items to be displayed on a page.", + "description": "The number of campaigns to return per page. Must be between 1 and 100.", "key": "pageSize", - "value": "" + "value": "50" + }, + { + "description": "Optional filter for campaign status. Case-insensitive. Allowed values: `Draft`, `Running`, `Pending`, `Paused`, `Completed`, `Ended`.", + "key": "campaignStatus", + "value": "Ended" } ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId?sortBy=&sort=&page=&pageSize=", + "raw": "{{baseUrl}}/v3/campaign-management/campaign-groups/:campaignGroupName/campaigns?page=1&pageSize=50&campaignStatus=Ended", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "The name of the campaign group whose campaigns are to be retrieved. Case-insensitive matching.\n\n **Allowed characters:** - `A-Z`, `a-z`, `0-9`, `_` (underscore), space \n**Allowed Length** `1..64`", + "key": "campaignGroupName", + "value": "9gqgOyRzjRAWH_xdn0U624PohBst648V_wh8zKGOci aAwyqAj d6X_qy" } ] } }, - "status": "Not Found" - } - ] - }, - { - "name": "Get all Journey Actions for a template", - "request": { - "description": "Get all Journey Actions for a template in JDS. \n\nRole and Scope: It requires id full admin or any role with cjp:config_read or cjp:config_write scope.", - "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": "Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "Template ID", - "key": "templateId", - "value": "" - } - ] - } - }, - "response": [ + "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}", - "code": 200, + "body": "{\n \"code\": 504,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 504, "cookie": [], "header": [ { @@ -177415,7 +212041,7 @@ "value": "application/json" } ], - "name": "Success", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "header": [ { @@ -177429,232 +212055,114 @@ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + "v3", + "campaign-management", + "campaign-groups", + ":campaignGroupName", + "campaigns" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "The page number of the result set to retrieve (1-based).", + "key": "page", + "value": "1" }, { - "description": "Template ID", - "key": "templateId" - } - ] - } - }, - "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", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" - ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", - "variable": [ - { - "description": "Workspace ID", - "key": "workspaceId" + "description": "The number of campaigns to return per page. Must be between 1 and 100.", + "key": "pageSize", + "value": "50" }, { - "description": "Template ID", - "key": "templateId" + "description": "Optional filter for campaign status. Case-insensitive. Allowed values: `Draft`, `Running`, `Pending`, `Paused`, `Completed`, `Ended`.", + "key": "campaignStatus", + "value": "Ended" } - ] - } - }, - "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", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/v3/campaign-management/campaign-groups/:campaignGroupName/campaigns?page=1&pageSize=50&campaignStatus=Ended", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Template ID", - "key": "templateId" + "description": "The name of the campaign group whose campaigns are to be retrieved. Case-insensitive matching.\n\n **Allowed characters:** - `A-Z`, `a-z`, `0-9`, `_` (underscore), space \n**Allowed Length** `1..64`", + "key": "campaignGroupName", + "value": "9gqgOyRzjRAWH_xdn0U624PohBst648V_wh8zKGOci aAwyqAj d6X_qy" } ] } }, - "status": "Internal Server Error" - } - ] - }, - { - "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 },\n {\n \"type\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" + "status": "Gateway Timeout" }, - "description": "Create a new Journey Action in JDS. \n\n **Role and Scope**: It requires id full admin or any role with cjp:config_write scope.\n\n **Sample Input for Creating new Journey action**: \n ```\n {\n \"name\": \"Closed Queue Action\",\n \"cooldownPeriodInMinutes\": 1,\n \"rules\": {\n \"logic\": \"SINGLE\",\n \"condition\": \"Closed Queue,category,string,Value GTE 2\"\n },\n \"actionTriggers\": [\n {\n \"type\": \"Webhook\",\n \"webhookURL\": \"https://hooks.us.webexconnect.io/events/6M347NJ6\",\n \"attributes\": {\n \"httpverb\": \"post\",\n \"requestbody\": \"{\\\"SMS\\\":\\\"12263762551\\\",\\\"callID\\\":\\\"\\\",\\\"MessageToSend\\\":\\\"Hello there!\\\"}\"\n }\n }\n ],\n \"isActive\": true\n }\n ```\nThe action trigger's evaluation process is predicated on the progressive profile that has been established. \nIn this specific action trigger, the rule assessment verifies whether the progressive profile value from the prior template evaluation was in excess of 2. \nIf this condition is met, the webhook is subsequently activated.\n\n\nPrior to rule evaluation for actions, several conditions must be satisfied. \nFirstly, the event associated with the template must align with the rule event, which, in this case, is 'Closed Queue'. \nSecondly, the metadata assigned to the template must correspond with the metadata set by the rules, which in this context, is 'category'. \nThirdly, the aggregation mode of the template must be equivalent to the rules' aggregation mode, which is 'value' in this instance. \nFinally, the operator of the template's aggregation mode must match those defined for 'value'. \nIn this scenario, it is 'GTE' (greater than or equal), which is an accepted value for 'value'.\n", - "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": "Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "Template ID", - "key": "templateId", - "value": "" - } - ] - } - }, - "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"200 OK\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 400, + "body": "{\n \"code\": 429,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 429, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "description": { + "content": "Number of seconds to wait before retrying", + "type": "text/plain" + }, + "disabled": false, + "key": "Retry-After", + "value": "" } ], - "name": "Bad Request", + "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 \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\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", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + "v3", + "campaign-management", + "campaign-groups", + ":campaignGroupName", + "campaigns" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "The page number of the result set to retrieve (1-based).", + "key": "page", + "value": "1" }, { - "description": "Template ID", - "key": "templateId" + "description": "The number of campaigns to return per page. Must be between 1 and 100.", + "key": "pageSize", + "value": "50" + }, + { + "description": "Optional filter for campaign status. Case-insensitive. Allowed values: `Draft`, `Running`, `Pending`, `Paused`, `Completed`, `Ended`.", + "key": "campaignStatus", + "value": "Ended" + } + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaign-groups/:campaignGroupName/campaigns?page=1&pageSize=50&campaignStatus=Ended", + "variable": [ + { + "description": "The name of the campaign group whose campaigns are to be retrieved. Case-insensitive matching.\n\n **Allowed characters:** - `A-Z`, `a-z`, `0-9`, `_` (underscore), space \n**Allowed Length** `1..64`", + "key": "campaignGroupName", + "value": "9gqgOyRzjRAWH_xdn0U624PohBst648V_wh8zKGOci aAwyqAj d6X_qy" } ] } }, - "status": "Bad Request" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 500, + "body": "{\n \"code\": 503,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 503, "cookie": [], "header": [ { @@ -177662,62 +212170,59 @@ "value": "application/json" } ], - "name": "Internal server error", + "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 \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\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", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + "v3", + "campaign-management", + "campaign-groups", + ":campaignGroupName", + "campaigns" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "The page number of the result set to retrieve (1-based).", + "key": "page", + "value": "1" }, { - "description": "Template ID", - "key": "templateId" + "description": "The number of campaigns to return per page. Must be between 1 and 100.", + "key": "pageSize", + "value": "50" + }, + { + "description": "Optional filter for campaign status. Case-insensitive. Allowed values: `Draft`, `Running`, `Pending`, `Paused`, `Completed`, `Ended`.", + "key": "campaignStatus", + "value": "Ended" + } + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaign-groups/:campaignGroupName/campaigns?page=1&pageSize=50&campaignStatus=Ended", + "variable": [ + { + "description": "The name of the campaign group whose campaigns are to be retrieved. Case-insensitive matching.\n\n **Allowed characters:** - `A-Z`, `a-z`, `0-9`, `_` (underscore), space \n**Allowed Length** `1..64`", + "key": "campaignGroupName", + "value": "9gqgOyRzjRAWH_xdn0U624PohBst648V_wh8zKGOci aAwyqAj d6X_qy" } ] } }, - "status": "Internal Server Error" + "status": "Service Unavailable" }, { "_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 \"code\": 403,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 403, "cookie": [], "header": [ { @@ -177725,156 +212230,118 @@ "value": "application/json" } ], - "name": "Accepted", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed. The feature may not be enabled for this organization or the user lacks required permissions.", "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 },\n {\n \"type\": \"\"\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", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + "v3", + "campaign-management", + "campaign-groups", + ":campaignGroupName", + "campaigns" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "The page number of the result set to retrieve (1-based).", + "key": "page", + "value": "1" + }, + { + "description": "The number of campaigns to return per page. Must be between 1 and 100.", + "key": "pageSize", + "value": "50" }, { - "description": "Template ID", - "key": "templateId" + "description": "Optional filter for campaign status. Case-insensitive. Allowed values: `Draft`, `Running`, `Pending`, `Paused`, `Completed`, `Ended`.", + "key": "campaignStatus", + "value": "Ended" + } + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaign-groups/:campaignGroupName/campaigns?page=1&pageSize=50&campaignStatus=Ended", + "variable": [ + { + "description": "The name of the campaign group whose campaigns are to be retrieved. Case-insensitive matching.\n\n **Allowed characters:** - `A-Z`, `a-z`, `0-9`, `_` (underscore), space \n**Allowed Length** `1..64`", + "key": "campaignGroupName", + "value": "9gqgOyRzjRAWH_xdn0U624PohBst648V_wh8zKGOci aAwyqAj d6X_qy" } ] } }, - "status": "Created" - } - ] - }, - { - "name": "Get specific Journey Action By Name", - "request": { - "description": "Get specific Journey Action By Name in JDS. \n\nRole and Scope:It requires id full admin or any role with cjp:config_read or cjp:config_write scope.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "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": [ - { - "description": "Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "Template ID", - "key": "templateId", - "value": "" - }, - { - "description": "Action Name", - "key": "actionName", - "value": "" - } - ] - } - }, - "response": [ + "status": "Forbidden" + }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "_postman_previewlanguage": "json", + "body": "{\n \"code\": 401,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", + "code": 401, "cookie": [], - "header": [], - "name": "Internal error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-name", - ":actionName" + "v3", + "campaign-management", + "campaign-groups", + ":campaignGroupName", + "campaigns" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-name/:actionName", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "The page number of the result set to retrieve (1-based).", + "key": "page", + "value": "1" }, { - "description": "Template ID", - "key": "templateId" + "description": "The number of campaigns to return per page. Must be between 1 and 100.", + "key": "pageSize", + "value": "50" }, { - "description": "Action Name", - "key": "actionName" + "description": "Optional filter for campaign status. Case-insensitive. Allowed values: `Draft`, `Running`, `Pending`, `Paused`, `Completed`, `Ended`.", + "key": "campaignStatus", + "value": "Ended" + } + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaign-groups/:campaignGroupName/campaigns?page=1&pageSize=50&campaignStatus=Ended", + "variable": [ + { + "description": "The name of the campaign group whose campaigns are to be retrieved. Case-insensitive matching.\n\n **Allowed characters:** - `A-Z`, `a-z`, `0-9`, `_` (underscore), space \n**Allowed Length** `1..64`", + "key": "campaignGroupName", + "value": "9gqgOyRzjRAWH_xdn0U624PohBst648V_wh8zKGOci aAwyqAj d6X_qy" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_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 \"outcome\": \"\",\n \"statusCode\": \"\",\n \"campaigns\": [\n {\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"campaignGroupName\": \"\",\n \"channel\": \"\",\n \"campaignType\": \"Advanced\",\n \"campaignDialingMode\": \"Predictive\",\n \"status\": \"Paused\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"sourceCampaigns\": [\n \"\",\n \"\"\n ],\n \"fieldMapping\": \"\",\n \"timezone\": \"\",\n \"scheduleType\": \"Basic\",\n \"scheduleInfo\": [\n {\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"safeCallingWindow\": [\n {\n \"scwStartTime\": \"\",\n \"scwEndTime\": \"\"\n },\n {\n \"scwStartTime\": \"\",\n \"scwEndTime\": \"\"\n }\n ],\n \"contactAttemptsStrategy\": {\n \"maxAttempts\": [\n {\n \"interval\": \"\",\n \"maxCount\": \"\"\n },\n {\n \"interval\": \"\",\n \"maxCount\": \"\"\n }\n ],\n \"contactModesPriority\": [\n {\n \"mode\": \"\",\n \"priority\": \"\",\n \"maxCount\": \"\"\n },\n {\n \"mode\": \"\",\n \"priority\": \"\",\n \"maxCount\": \"\"\n }\n ],\n \"sequentialDialing\": {\n \"enabled\": 0,\n \"noOfCycles\": \"\",\n \"cycleInterval\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"wrapUpCodesSet\": \"\",\n \"telephonyOutcomeSet\": \"\"\n },\n \"contactFlowPriority\": {\n \"priorityBasedOn\": \"FreshVsRetry\",\n \"retryPercentage\": \"\",\n \"retryPriority\": \"FIFO\",\n \"freshPercentage\": \"\",\n \"freshPriority\": \"FIFO\"\n },\n \"campaignCreatedBy\": \"\",\n \"controlHubChannelEntryPointID\": \"\",\n \"outdialANI\": \"\",\n \"dncLists\": [\n \"\",\n \"\"\n ],\n \"purposeTags\": [\n \"\",\n \"\"\n ],\n \"pAndLTag\": \"\",\n \"cpaEnabled\": \"Yes\",\n \"numberOfSFTPContactLists\": \"\",\n \"numberOfAPIContactLists\": \"\",\n \"numberOfManualFileContactLists\": \"\"\n },\n {\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"campaignGroupName\": \"\",\n \"channel\": \"\",\n \"campaignType\": \"Basic\",\n \"campaignDialingMode\": \"DirectPreview\",\n \"status\": \"Paused\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"sourceCampaigns\": [\n \"\",\n \"\"\n ],\n \"fieldMapping\": \"\",\n \"timezone\": \"\",\n \"scheduleType\": \"Advanced\",\n \"scheduleInfo\": [\n {\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"safeCallingWindow\": [\n {\n \"scwStartTime\": \"\",\n \"scwEndTime\": \"\"\n },\n {\n \"scwStartTime\": \"\",\n \"scwEndTime\": \"\"\n }\n ],\n \"contactAttemptsStrategy\": {\n \"maxAttempts\": [\n {\n \"interval\": \"\",\n \"maxCount\": \"\"\n },\n {\n \"interval\": \"\",\n \"maxCount\": \"\"\n }\n ],\n \"contactModesPriority\": [\n {\n \"mode\": \"\",\n \"priority\": \"\",\n \"maxCount\": \"\"\n },\n {\n \"mode\": \"\",\n \"priority\": \"\",\n \"maxCount\": \"\"\n }\n ],\n \"sequentialDialing\": {\n \"enabled\": 0,\n \"noOfCycles\": \"\",\n \"cycleInterval\": {\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\"\n }\n },\n \"wrapUpCodesSet\": \"\",\n \"telephonyOutcomeSet\": \"\"\n },\n \"contactFlowPriority\": {\n \"priorityBasedOn\": \"FreshVsRetry\",\n \"retryPercentage\": \"\",\n \"retryPriority\": \"LIFO\",\n \"freshPercentage\": \"\",\n \"freshPriority\": \"FIFO\"\n },\n \"campaignCreatedBy\": \"\",\n \"controlHubChannelEntryPointID\": \"\",\n \"outdialANI\": \"\",\n \"dncLists\": [\n \"\",\n \"\"\n ],\n \"purposeTags\": [\n \"\",\n \"\"\n ],\n \"pAndLTag\": \"\",\n \"cpaEnabled\": \"No\",\n \"numberOfSFTPContactLists\": \"\",\n \"numberOfAPIContactLists\": \"\",\n \"numberOfManualFileContactLists\": \"\"\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalCount\": \"\",\n \"totalPages\": \"\"\n }\n}", "code": 200, "cookie": [], "header": [ @@ -177883,7 +212350,7 @@ "value": "application/json" } ], - "name": "Success", + "name": "Campaigns successfully retrieved for the specified campaign group.", "originalRequest": { "header": [ { @@ -177897,30 +212364,35 @@ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-name", - ":actionName" + "v3", + "campaign-management", + "campaign-groups", + ":campaignGroupName", + "campaigns" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-name/:actionName", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "The page number of the result set to retrieve (1-based).", + "key": "page", + "value": "1" }, { - "description": "Template ID", - "key": "templateId" + "description": "The number of campaigns to return per page. Must be between 1 and 100.", + "key": "pageSize", + "value": "50" }, { - "description": "Action Name", - "key": "actionName" + "description": "Optional filter for campaign status. Case-insensitive. Allowed values: `Draft`, `Running`, `Pending`, `Paused`, `Completed`, `Ended`.", + "key": "campaignStatus", + "value": "Ended" + } + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaign-groups/:campaignGroupName/campaigns?page=1&pageSize=50&campaignStatus=Ended", + "variable": [ + { + "description": "The name of the campaign group whose campaigns are to be retrieved. Case-insensitive matching.\n\n **Allowed characters:** - `A-Z`, `a-z`, `0-9`, `_` (underscore), space \n**Allowed Length** `1..64`", + "key": "campaignGroupName", + "value": "9gqgOyRzjRAWH_xdn0U624PohBst648V_wh8zKGOci aAwyqAj d6X_qy" } ] } @@ -177928,44 +212400,59 @@ "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"trackingId\": \"\"\n}", "code": 404, "cookie": [], - "header": [], - "name": "Not found", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Not Found: The specified campaign group does not exist.", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-name", - ":actionName" + "v3", + "campaign-management", + "campaign-groups", + ":campaignGroupName", + "campaigns" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-name/:actionName", - "variable": [ + "query": [ { - "description": "Workspace ID", - "key": "workspaceId" + "description": "The page number of the result set to retrieve (1-based).", + "key": "page", + "value": "1" }, { - "description": "Template ID", - "key": "templateId" + "description": "The number of campaigns to return per page. Must be between 1 and 100.", + "key": "pageSize", + "value": "50" }, { - "description": "Action Name", - "key": "actionName" + "description": "Optional filter for campaign status. Case-insensitive. Allowed values: `Draft`, `Running`, `Pending`, `Paused`, `Completed`, `Ended`.", + "key": "campaignStatus", + "value": "Ended" + } + ], + "raw": "{{baseUrl}}/v3/campaign-management/campaign-groups/:campaignGroupName/campaigns?page=1&pageSize=50&campaignStatus=Ended", + "variable": [ + { + "description": "The name of the campaign group whose campaigns are to be retrieved. Case-insensitive matching.\n\n **Allowed characters:** - `A-Z`, `a-z`, `0-9`, `_` (underscore), space \n**Allowed Length** `1..64`", + "key": "campaignGroupName", + "value": "9gqgOyRzjRAWH_xdn0U624PohBst648V_wh8zKGOci aAwyqAj d6X_qy" } ] } @@ -177973,12 +212460,28 @@ "status": "Not Found" } ] - }, + } + ], + "name": "Campaign Group" + }, + { + "description": "Discover fields and capabilities supported by the Webex Contact Center Search API.", + "item": [ { - "name": "Get specific Journey Action By ActionId", + "name": "Get Search Metadata", "request": { - "description": "Get specific Journey Action By ActionId in JDS. \n\nRole and Scope: It requires id full admin role with cjp:config_read or cjp:config_write scope.", + "description": "Returns schema metadata for the Webex Contact Center Search GraphQL API, describing supported queries, fields, nested structures, data types, filters, sorting options, grouping capabilities, and aggregation operations.\n\n**Authentication & Authorization:**\n- **Required Scopes:** `cjp:config` or `cjp:config_read`\n\nAn asterisk (*) in the rendered response schema indicates a required property.", "header": [ + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "X-ORGANIZATION-ID", + "value": "D74Dedc9-B64E-2CED-A686-BAc272aE8623" + }, + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, { "key": "Accept", "value": "application/json" @@ -177990,131 +212493,193 @@ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" + "search", + "v2", + "meta" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", - "variable": [ - { - "description": "Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "Template ID", - "key": "templateId", - "value": "" - }, - { - "description": "Action ID", - "key": "actionId", - "value": "" - } - ] + "raw": "{{baseUrl}}/search/v2/meta" } }, "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": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Validation Error", + "originalRequest": { + "header": [ + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "X-ORGANIZATION-ID", + "value": "D74Dedc9-B64E-2CED-A686-BAc272aE8623" + }, + { + "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": [ + "search", + "v2", + "meta" + ], + "raw": "{{baseUrl}}/search/v2/meta" + } + }, + "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": [], - "name": "Internal error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", "originalRequest": { - "header": [], + "header": [ + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "X-ORGANIZATION-ID", + "value": "D74Dedc9-B64E-2CED-A686-BAc272aE8623" + }, + { + "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": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" + "search", + "v2", + "meta" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", - "variable": [ - { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Template ID", - "key": "templateId" - }, - { - "description": "Action ID", - "key": "actionId" - } - ] + "raw": "{{baseUrl}}/search/v2/meta" } }, "status": "Internal Server Error" }, { "_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", + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "Forbidden", "originalRequest": { - "header": [], + "header": [ + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "X-ORGANIZATION-ID", + "value": "D74Dedc9-B64E-2CED-A686-BAc272aE8623" + }, + { + "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": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" + "search", + "v2", + "meta" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", - "variable": [ - { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Template ID", - "key": "templateId" - }, - { - "description": "Action ID", - "key": "actionId" - } - ] + "raw": "{{baseUrl}}/search/v2/meta" } }, - "status": "Not Found" + "status": "Forbidden" }, { "_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 \"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": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "X-ORGANIZATION-ID", + "value": "D74Dedc9-B64E-2CED-A686-BAc272aE8623" + }, + { + "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": [ + "search", + "v2", + "meta" + ], + "raw": "{{baseUrl}}/search/v2/meta" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"queries\": [\n {\n \"name\": \"\",\n \"deprecated\": \"\",\n \"type\": {\n \"kind\": \"LIST\",\n \"name\": \"\",\n \"ofType\": {\n \"description\": \"Wrapped GraphQL type for list and non-null kinds.\",\n \"example\": {\n \"name\": \"String\",\n \"kind\": \"SCALAR\"\n },\n \"value\": \"\"\n }\n },\n \"systemField\": \"\",\n \"description\": \"\",\n \"fields\": [\n {\n \"name\": \"\",\n \"deprecated\": \"\",\n \"type\": {\n \"kind\": \"LIST\",\n \"name\": \"\",\n \"ofType\": {\n \"description\": \"Wrapped GraphQL type for list and non-null kinds.\",\n \"example\": {\n \"name\": \"String\",\n \"kind\": \"SCALAR\"\n },\n \"value\": \"\"\n }\n },\n \"systemField\": \"\",\n \"sortable\": \"\",\n \"fieldType\": \"COMMON\",\n \"filter\": \"filter\",\n \"groupBy\": \"\",\n \"description\": \"\",\n \"aggregation\": {\n \"aggregationType\": \"SUMMARY\",\n \"operations\": [\n \"cardinality\",\n \"average\"\n ]\n }\n },\n {\n \"description\": \"A nested object or leaf field in the Search metadata response.\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"deprecated\": \"\",\n \"type\": {\n \"kind\": \"NON_NULL\",\n \"name\": \"\",\n \"ofType\": {\n \"description\": \"Wrapped GraphQL type for list and non-null kinds.\",\n \"example\": {\n \"name\": \"String\",\n \"kind\": \"SCALAR\"\n },\n \"value\": \"\"\n }\n },\n \"systemField\": \"\",\n \"description\": \"\",\n \"fields\": [\n {\n \"description\": \"A nested object or leaf field in the Search metadata response.\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"deprecated\": \"\",\n \"type\": {\n \"kind\": \"INTERFACE\",\n \"name\": \"\",\n \"ofType\": {\n \"description\": \"Wrapped GraphQL type for list and non-null kinds.\",\n \"example\": {\n \"name\": \"String\",\n \"kind\": \"SCALAR\"\n },\n \"value\": \"\"\n }\n },\n \"systemField\": \"\",\n \"sortable\": \"\",\n \"fieldType\": \"GRANULAR\",\n \"filter\": \"filter\",\n \"groupBy\": \"\",\n \"description\": \"\",\n \"aggregation\": {\n \"aggregationType\": \"GRANULAR\",\n \"operations\": [\n \"sum\",\n \"cardinality\"\n ]\n }\n }\n ]\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -178123,9 +212688,19 @@ "value": "application/json" } ], - "name": "Success", + "name": "OK", "originalRequest": { "header": [ + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "X-ORGANIZATION-ID", + "value": "D74Dedc9-B64E-2CED-A686-BAc272aE8623" + }, + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, { "key": "Accept", "value": "application/json" @@ -178137,40 +212712,24 @@ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" + "search", + "v2", + "meta" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", - "variable": [ - { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Template ID", - "key": "templateId" - }, - { - "description": "Action ID", - "key": "actionId" - } - ] + "raw": "{{baseUrl}}/search/v2/meta" } }, "status": "OK" } ] - }, + } + ], + "name": "Search Metadata" + }, + { + "item": [ { - "name": "Update existing Journey Action", + "name": "Create a new Asset", "request": { "body": { "mode": "raw", @@ -178180,9 +212739,9 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" + "raw": "{\n \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, - "description": "Update existing Journey Action in JDS. \n\nRole and Scope: It requires id full admin or any role with cjp:config_write scope.", + "description": "Create a new Asset in a given organization. Supports work item assets with the specified channel and data schema.", "header": [ { "key": "Content-Type", @@ -178190,41 +212749,24 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" + "organization", + ":orgid", + "asset" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "raw": "{{baseUrl}}/organization/:orgid/asset", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "Template ID", - "key": "templateId", - "value": "" - }, - { - "description": "Action ID", - "key": "actionId", + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", "value": "" } ] @@ -178233,8 +212775,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"200 OK\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 400, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { @@ -178242,7 +212784,7 @@ "value": "application/json" } ], - "name": "Bad Request", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -178252,7 +212794,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" + "raw": "{\n \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -178264,46 +212806,32 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" + "organization", + ":orgid", + "asset" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "raw": "{{baseUrl}}/organization/:orgid/asset", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Template ID", - "key": "templateId" - }, - { - "description": "Action ID", - "key": "actionId" + "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": "Bad Request" + "status": "Forbidden" }, { "_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 \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { @@ -178311,7 +212839,7 @@ "value": "application/json" } ], - "name": "Accepted", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -178321,7 +212849,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" + "raw": "{\n \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -178333,46 +212861,32 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" + "organization", + ":orgid", + "asset" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "raw": "{{baseUrl}}/organization/:orgid/asset", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Template ID", - "key": "templateId" - }, - { - "description": "Action ID", - "key": "actionId" + "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": "Created" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 500, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { @@ -178380,7 +212894,7 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -178390,7 +212904,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" + "raw": "{\n \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -178402,141 +212916,32 @@ "value": "application/json" } ], - "method": "PUT", - "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": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Template ID", - "key": "templateId" - }, - { - "description": "Action ID", - "key": "actionId" - } - ] - } - }, - "status": "Internal Server Error" - } - ] - }, - { - "name": "Delete Journey Action configuration By ActionId", - "request": { - "description": "Delete Journey Action configuration By ActionId in JDS. \n\nRole and Scope: It requires id full admin role with 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": "Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "Template ID", - "key": "templateId", - "value": "" - }, - { - "description": "Action ID", - "key": "actionId", - "value": "" - } - ] - } - }, - "response": [ - { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, - "cookie": [], - "header": [], - "name": "Internal error", - "originalRequest": { - "header": [], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" + "organization", + ":orgid", + "asset" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "raw": "{{baseUrl}}/organization/:orgid/asset", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Template ID", - "key": "templateId" - }, - { - "description": "Action ID", - "key": "actionId" + "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": "Internal Server Error" + "status": "Too Many Requests" }, { "_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}", - "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": [ { @@ -178544,183 +212949,109 @@ "value": "application/json" } ], - "name": "Success", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" + "organization", + ":orgid", + "asset" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "raw": "{{baseUrl}}/organization/:orgid/asset", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Template ID", - "key": "templateId" - }, - { - "description": "Action ID", - "key": "actionId" + "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": "OK" + "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": [ - { - "description": "Workspace ID", - "key": "workspaceId" - }, - { - "description": "Template ID", - "key": "templateId" - }, - { - "description": "Action ID", - "key": "actionId" - } - ] - } - }, - "status": "Not Found" - } - ] - } - ], - "name": "Journey - Trigger Actions API" - }, - { - "item": [ - { - "name": "Get Workspace", - "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", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" - ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", - "variable": [ - { - "description": "Workspace ID", - "key": "workspaceId", - "value": "" - } - ] - } - }, - "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 \"businessAddress\": \"Rq@3X42E01\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"m-kQv\u2005IxX\u2029\",\n \"organizationId\": \"4e9BcDfa3A9CC6C7-edfC-F8F0a7a7D8dA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"channelName\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"kUSI_VM0 JiF9O\u2002uW2\\rswNC_kjWWmLjnkp_2P4-B\u2005tU\u200a6LsYDBD6EM-ZHKEJZs\",\n \"fieldKey\": \"v3-D\u180eLKtSBe7m-MA\",\n \"id\": \"\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"PJ8-OL4kGvcG\u2003rM1uDYP\u2003wkH5Xt2ok_ypo0hj\\rj2dEW6zYnNm-kGZ\u2001Doj_XmFT\",\n \"fieldKey\": \"Zp\u2002EluBWBYEF7_HTIiphkdKFaW\",\n \"id\": \"\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 201, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Ok", + "name": "Created", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" + "organization", + ":orgid", + "asset" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/organization/:orgid/asset", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "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": "OK" + "status": "Created" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 404, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 409, "cookie": [], "header": [ { @@ -178728,42 +213059,54 @@ "value": "application/json" } ], - "name": "Resource not found", + "name": "Similar entity is already present", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\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}}" ], "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" + "organization", + ":orgid", + "asset" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/organization/:orgid/asset", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "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": "Not Found" + "status": "Conflict" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ { @@ -178771,42 +213114,102 @@ "value": "application/json" } ], - "name": "Internal server error", + "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 \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\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}}" ], "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" + "organization", + ":orgid", + "asset" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/organization/:orgid/asset", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "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": "Internal Server Error" + "status": "Bad Request" + } + ] + }, + { + "name": "Bulk save Assets", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"businessAddress\": \"y+/vw`\",\n \"channelId\": \"\",\n \"channelType\": \"WORK_ITEM\",\n \"name\": \"colNi\u2001\u205f\",\n \"organizationId\": \"418595C2cEa2-b109-0eC3-2eCA46edBa2b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"gE1s5ctg912T6PSPsjIrTRG8GLpb\",\n \"fieldKey\": \"9pZ_QS0HS-BhoNrSXVB0WKDrM_\u202834aNz4ejnk_UCuf\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"EVrQhYZZ6dwR\u200aRIalhADM\",\n \"fieldKey\": \"P2JAnEU1OH0qyn_SY_\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"businessAddress\": \"xxEkiNjcW~\",\n \"channelId\": \"\",\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"name\": \"g(QUCd\u2000\",\n \"organizationId\": \"d3Dc97c3-2B4d-8e09FBd6-abbf3C4Bd7f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"i24S 7zXj9P\\nw8VZ5j\u2008qy4PX_sVwVdofH-n5mrUlX\\rw\u2001IrflI6GxLzg\u20042VD_v9z\",\n \"fieldKey\": \"HvsELSdUBL\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"yxKQ 8\\n6r-n3BjJw\\tj4\ufeff-t63TMJSUDpJ5w5\\fsDR6r2ScZk\u00a0T2htxfDTq9r\u180eWb4v\",\n \"fieldKey\": \"mmSt\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, + "description": "Create, Update or delete Assets in bulk in a given organization. Supports CREATE, UPDATE, and DELETE actions in a single request.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "asset", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/asset/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 \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 409, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { @@ -178814,42 +213217,55 @@ "value": "application/json" } ], - "name": "Resource already exists", + "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 \"businessAddress\": \"y+/vw`\",\n \"channelId\": \"\",\n \"channelType\": \"WORK_ITEM\",\n \"name\": \"colNi\u2001\u205f\",\n \"organizationId\": \"418595C2cEa2-b109-0eC3-2eCA46edBa2b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"gE1s5ctg912T6PSPsjIrTRG8GLpb\",\n \"fieldKey\": \"9pZ_QS0HS-BhoNrSXVB0WKDrM_\u202834aNz4ejnk_UCuf\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"EVrQhYZZ6dwR\u200aRIalhADM\",\n \"fieldKey\": \"P2JAnEU1OH0qyn_SY_\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"businessAddress\": \"xxEkiNjcW~\",\n \"channelId\": \"\",\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"name\": \"g(QUCd\u2000\",\n \"organizationId\": \"d3Dc97c3-2B4d-8e09FBd6-abbf3C4Bd7f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"i24S 7zXj9P\\nw8VZ5j\u2008qy4PX_sVwVdofH-n5mrUlX\\rw\u2001IrflI6GxLzg\u20042VD_v9z\",\n \"fieldKey\": \"HvsELSdUBL\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"yxKQ 8\\n6r-n3BjJw\\tj4\ufeff-t63TMJSUDpJ5w5\\fsDR6r2ScZk\u00a0T2htxfDTq9r\u180eWb4v\",\n \"fieldKey\": \"mmSt\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\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}}" ], "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" + "organization", + ":orgid", + "asset", + "bulk" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/organization/:orgid/asset/bulk", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "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": "Conflict" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 429, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { @@ -178857,100 +213273,63 @@ "value": "application/json" } ], - "name": "Too many requests", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"businessAddress\": \"y+/vw`\",\n \"channelId\": \"\",\n \"channelType\": \"WORK_ITEM\",\n \"name\": \"colNi\u2001\u205f\",\n \"organizationId\": \"418595C2cEa2-b109-0eC3-2eCA46edBa2b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"gE1s5ctg912T6PSPsjIrTRG8GLpb\",\n \"fieldKey\": \"9pZ_QS0HS-BhoNrSXVB0WKDrM_\u202834aNz4ejnk_UCuf\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"EVrQhYZZ6dwR\u200aRIalhADM\",\n \"fieldKey\": \"P2JAnEU1OH0qyn_SY_\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"businessAddress\": \"xxEkiNjcW~\",\n \"channelId\": \"\",\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"name\": \"g(QUCd\u2000\",\n \"organizationId\": \"d3Dc97c3-2B4d-8e09FBd6-abbf3C4Bd7f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"i24S 7zXj9P\\nw8VZ5j\u2008qy4PX_sVwVdofH-n5mrUlX\\rw\u2001IrflI6GxLzg\u20042VD_v9z\",\n \"fieldKey\": \"HvsELSdUBL\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"yxKQ 8\\n6r-n3BjJw\\tj4\ufeff-t63TMJSUDpJ5w5\\fsDR6r2ScZk\u00a0T2htxfDTq9r\u180eWb4v\",\n \"fieldKey\": \"mmSt\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\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}}" ], "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" + "organization", + ":orgid", + "asset", + "bulk" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/organization/:orgid/asset/bulk", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "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": "Too Many Requests" - } - ] - }, - { - "name": "Update Workspace", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" + "status": "Internal Server Error" }, - "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": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" - ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", - "variable": [ - { - "description": "Workspace ID", - "key": "workspaceId", - "value": "" - } - ] - } - }, - "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"items\": [\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 \"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": "Too many requests", + "name": "Multi-Status", "originalRequest": { "body": { "mode": "raw", @@ -178960,7 +213339,7 @@ "language": "json" } }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"businessAddress\": \"y+/vw`\",\n \"channelId\": \"\",\n \"channelType\": \"WORK_ITEM\",\n \"name\": \"colNi\u2001\u205f\",\n \"organizationId\": \"418595C2cEa2-b109-0eC3-2eCA46edBa2b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"gE1s5ctg912T6PSPsjIrTRG8GLpb\",\n \"fieldKey\": \"9pZ_QS0HS-BhoNrSXVB0WKDrM_\u202834aNz4ejnk_UCuf\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"EVrQhYZZ6dwR\u200aRIalhADM\",\n \"fieldKey\": \"P2JAnEU1OH0qyn_SY_\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"businessAddress\": \"xxEkiNjcW~\",\n \"channelId\": \"\",\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"name\": \"g(QUCd\u2000\",\n \"organizationId\": \"d3Dc97c3-2B4d-8e09FBd6-abbf3C4Bd7f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"i24S 7zXj9P\\nw8VZ5j\u2008qy4PX_sVwVdofH-n5mrUlX\\rw\u2001IrflI6GxLzg\u20042VD_v9z\",\n \"fieldKey\": \"HvsELSdUBL\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"yxKQ 8\\n6r-n3BjJw\\tj4\ufeff-t63TMJSUDpJ5w5\\fsDR6r2ScZk\u00a0T2htxfDTq9r\u180eWb4v\",\n \"fieldKey\": \"mmSt\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -178969,37 +213348,36 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" + "organization", + ":orgid", + "asset", + "bulk" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/organization/:orgid/asset/bulk", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "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": "Too Many Requests" + "status": "Multi-Status (WebDAV) (RFC 4918)" }, { "_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 \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 409, "cookie": [], "header": [ { @@ -179007,7 +213385,7 @@ "value": "application/json" } ], - "name": "Ok", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -179017,7 +213395,7 @@ "language": "json" } }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"businessAddress\": \"y+/vw`\",\n \"channelId\": \"\",\n \"channelType\": \"WORK_ITEM\",\n \"name\": \"colNi\u2001\u205f\",\n \"organizationId\": \"418595C2cEa2-b109-0eC3-2eCA46edBa2b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"gE1s5ctg912T6PSPsjIrTRG8GLpb\",\n \"fieldKey\": \"9pZ_QS0HS-BhoNrSXVB0WKDrM_\u202834aNz4ejnk_UCuf\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"EVrQhYZZ6dwR\u200aRIalhADM\",\n \"fieldKey\": \"P2JAnEU1OH0qyn_SY_\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"businessAddress\": \"xxEkiNjcW~\",\n \"channelId\": \"\",\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"name\": \"g(QUCd\u2000\",\n \"organizationId\": \"d3Dc97c3-2B4d-8e09FBd6-abbf3C4Bd7f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"i24S 7zXj9P\\nw8VZ5j\u2008qy4PX_sVwVdofH-n5mrUlX\\rw\u2001IrflI6GxLzg\u20042VD_v9z\",\n \"fieldKey\": \"HvsELSdUBL\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"yxKQ 8\\n6r-n3BjJw\\tj4\ufeff-t63TMJSUDpJ5w5\\fsDR6r2ScZk\u00a0T2htxfDTq9r\u180eWb4v\",\n \"fieldKey\": \"mmSt\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -179029,34 +213407,33 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" + "organization", + ":orgid", + "asset", + "bulk" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/organization/:orgid/asset/bulk", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "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": "OK" + "status": "Conflict" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 404, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { @@ -179064,7 +213441,7 @@ "value": "application/json" } ], - "name": "Resource not found", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -179074,7 +213451,7 @@ "language": "json" } }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"businessAddress\": \"y+/vw`\",\n \"channelId\": \"\",\n \"channelType\": \"WORK_ITEM\",\n \"name\": \"colNi\u2001\u205f\",\n \"organizationId\": \"418595C2cEa2-b109-0eC3-2eCA46edBa2b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"gE1s5ctg912T6PSPsjIrTRG8GLpb\",\n \"fieldKey\": \"9pZ_QS0HS-BhoNrSXVB0WKDrM_\u202834aNz4ejnk_UCuf\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"EVrQhYZZ6dwR\u200aRIalhADM\",\n \"fieldKey\": \"P2JAnEU1OH0qyn_SY_\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"businessAddress\": \"xxEkiNjcW~\",\n \"channelId\": \"\",\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"name\": \"g(QUCd\u2000\",\n \"organizationId\": \"d3Dc97c3-2B4d-8e09FBd6-abbf3C4Bd7f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"i24S 7zXj9P\\nw8VZ5j\u2008qy4PX_sVwVdofH-n5mrUlX\\rw\u2001IrflI6GxLzg\u20042VD_v9z\",\n \"fieldKey\": \"HvsELSdUBL\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"yxKQ 8\\n6r-n3BjJw\\tj4\ufeff-t63TMJSUDpJ5w5\\fsDR6r2ScZk\u00a0T2htxfDTq9r\u180eWb4v\",\n \"fieldKey\": \"mmSt\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -179086,34 +213463,33 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" + "organization", + ":orgid", + "asset", + "bulk" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/organization/:orgid/asset/bulk", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "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": "Not Found" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 500, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { @@ -179121,7 +213497,7 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -179131,7 +213507,7 @@ "language": "json" } }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"businessAddress\": \"y+/vw`\",\n \"channelId\": \"\",\n \"channelType\": \"WORK_ITEM\",\n \"name\": \"colNi\u2001\u205f\",\n \"organizationId\": \"418595C2cEa2-b109-0eC3-2eCA46edBa2b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"gE1s5ctg912T6PSPsjIrTRG8GLpb\",\n \"fieldKey\": \"9pZ_QS0HS-BhoNrSXVB0WKDrM_\u202834aNz4ejnk_UCuf\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"EVrQhYZZ6dwR\u200aRIalhADM\",\n \"fieldKey\": \"P2JAnEU1OH0qyn_SY_\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"businessAddress\": \"xxEkiNjcW~\",\n \"channelId\": \"\",\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"name\": \"g(QUCd\u2000\",\n \"organizationId\": \"d3Dc97c3-2B4d-8e09FBd6-abbf3C4Bd7f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"i24S 7zXj9P\\nw8VZ5j\u2008qy4PX_sVwVdofH-n5mrUlX\\rw\u2001IrflI6GxLzg\u20042VD_v9z\",\n \"fieldKey\": \"HvsELSdUBL\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"yxKQ 8\\n6r-n3BjJw\\tj4\ufeff-t63TMJSUDpJ5w5\\fsDR6r2ScZk\u00a0T2htxfDTq9r\u180eWb4v\",\n \"fieldKey\": \"mmSt\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -179143,34 +213519,33 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" + "organization", + ":orgid", + "asset", + "bulk" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/organization/:orgid/asset/bulk", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "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": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "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": [ { @@ -179178,7 +213553,7 @@ "value": "application/json" } ], - "name": "Resource already exists", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -179188,7 +213563,7 @@ "language": "json" } }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"businessAddress\": \"y+/vw`\",\n \"channelId\": \"\",\n \"channelType\": \"WORK_ITEM\",\n \"name\": \"colNi\u2001\u205f\",\n \"organizationId\": \"418595C2cEa2-b109-0eC3-2eCA46edBa2b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"gE1s5ctg912T6PSPsjIrTRG8GLpb\",\n \"fieldKey\": \"9pZ_QS0HS-BhoNrSXVB0WKDrM_\u202834aNz4ejnk_UCuf\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"EVrQhYZZ6dwR\u200aRIalhADM\",\n \"fieldKey\": \"P2JAnEU1OH0qyn_SY_\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"businessAddress\": \"xxEkiNjcW~\",\n \"channelId\": \"\",\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"name\": \"g(QUCd\u2000\",\n \"organizationId\": \"d3Dc97c3-2B4d-8e09FBd6-abbf3C4Bd7f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"i24S 7zXj9P\\nw8VZ5j\u2008qy4PX_sVwVdofH-n5mrUlX\\rw\u2001IrflI6GxLzg\u20042VD_v9z\",\n \"fieldKey\": \"HvsELSdUBL\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"yxKQ 8\\n6r-n3BjJw\\tj4\ufeff-t63TMJSUDpJ5w5\\fsDR6r2ScZk\u00a0T2htxfDTq9r\u180eWb4v\",\n \"fieldKey\": \"mmSt\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -179200,60 +213575,69 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" + "organization", + ":orgid", + "asset", + "bulk" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/organization/:orgid/asset/bulk", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "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": "Conflict" + "status": "Forbidden" } ] }, { - "name": "Delete Workspace", + "name": "Get specific Asset by ID", "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": "Retrieve an existing Asset by ID in a given organization. Set includeChannelName to true to include the channel name in the response.", "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "query": [ + { + "description": "Include channel name in the response.", + "key": "includeChannelName", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/asset/:id?includeChannelName=false", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId", + "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 Asset", + "key": "id", "value": "" } ] @@ -179262,8 +213646,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 429, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { @@ -179271,7 +213655,7 @@ "value": "application/json" } ], - "name": "Too many requests", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -179279,33 +213663,98 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "query": [ + { + "description": "Include channel name in the response.", + "key": "includeChannelName", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/asset/:id?includeChannelName=false", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "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 Asset", + "key": "id", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "asset", + ":id" + ], + "query": [ + { + "description": "Include channel name in the response.", + "key": "includeChannelName", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/asset/:id?includeChannelName=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 Asset", + "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": 404, "cookie": [], "header": [ @@ -179314,7 +213763,7 @@ "value": "application/json" } ], - "name": "Resource not found", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -179322,24 +213771,35 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "query": [ + { + "description": "Include channel name in the response.", + "key": "includeChannelName", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/asset/:id?includeChannelName=false", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "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 Asset", + "key": "id", + "value": "" } ] } @@ -179348,8 +213808,8 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 409, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { @@ -179357,7 +213817,7 @@ "value": "application/json" } ], - "name": "Resource already exists", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -179365,33 +213825,44 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "query": [ + { + "description": "Include channel name in the response.", + "key": "includeChannelName", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/asset/:id?includeChannelName=false", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "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 Asset", + "key": "id", + "value": "" } ] } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\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": [ @@ -179400,7 +213871,7 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -179408,24 +213879,35 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "query": [ + { + "description": "Include channel name in the response.", + "key": "includeChannelName", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/asset/:id?includeChannelName=false", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "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 Asset", + "key": "id", + "value": "" } ] } @@ -179433,42 +213915,53 @@ "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"wxccSubscriptionIds\": [\n \"\",\n \"\"\n ]\n }\n}", + "_postman_previewlanguage": "text", + "body": "{\n \"businessAddress\": \"Rq@3X42E01\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"m-kQv\u2005IxX\u2029\",\n \"organizationId\": \"4e9BcDfa3A9CC6C7-edfC-F8F0a7a7D8dA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"channelName\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"kUSI_VM0 JiF9O\u2002uW2\\rswNC_kjWWmLjnkp_2P4-B\u2005tU\u200a6LsYDBD6EM-ZHKEJZs\",\n \"fieldKey\": \"v3-D\u180eLKtSBe7m-MA\",\n \"id\": \"\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"PJ8-OL4kGvcG\u2003rM1uDYP\u2003wkH5Xt2ok_ypo0hj\\rj2dEW6zYnNm-kGZ\u2001Doj_XmFT\",\n \"fieldKey\": \"Zp\u2002EluBWBYEF7_HTIiphkdKFaW\",\n \"id\": \"\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Ok", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace", - "workspace-id", - ":workspaceId" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "query": [ + { + "description": "Include channel name in the response.", + "key": "includeChannelName", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/asset/:id?includeChannelName=false", "variable": [ { - "description": "Workspace ID", - "key": "workspaceId" + "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 Asset", + "key": "id", + "value": "" } ] } @@ -179478,61 +213971,60 @@ ] }, { - "name": "Get All Workspaces", + "name": "Update specific Asset by ID", "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "description": "Update an existing Asset by ID in a given organization. Supported for WORK_ITEM assets. For CUSTOM_MESSAGING assets, use PATCH instead.", "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace" + "organization", + ":orgid", + "asset", + ":id" ], - "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/documentation/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}}/organization/:orgid/asset/:id", + "variable": [ { - "description": "Sort By Field", - "key": "sortBy", + "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": "Sort direction", - "key": "sort", + "description": "Resource ID of the Asset", + "key": "id", "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 \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 409, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { @@ -179540,61 +214032,60 @@ "value": "application/json" } ], - "name": "Resource already exists", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\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}}" ], "path": [ - "admin", - "v1", - "api", - "workspace" + "organization", + ":orgid", + "asset", + ":id" ], - "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/documentation/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}}/organization/:orgid/asset/:id", + "variable": [ { - "description": "Sort By Field", - "key": "sortBy", + "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": "Sort direction", - "key": "sort", + "description": "Resource ID of the Asset", + "key": "id", "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": "Conflict" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 429, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { @@ -179602,61 +214093,121 @@ "value": "application/json" } ], - "name": "Too many requests", + "name": "Resource not found or URI is invalid", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\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}}" ], "path": [ - "admin", - "v1", - "api", - "workspace" + "organization", + ":orgid", + "asset", + ":id" ], - "query": [ + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", + "variable": [ { - "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/documentation/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": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", "value": "" }, { - "description": "Sort By Field", - "key": "sortBy", + "description": "Resource ID of the Asset", + "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": 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 \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\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", + "asset", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", + "variable": [ { - "description": "Sort direction", - "key": "sort", + "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": "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": "" + "description": "Resource ID of the Asset", + "key": "id", + "value": "" } - ], - "raw": "{{baseUrl}}/admin/v1/api/workspace?filter=&sortBy=&sort=&page=&pageSize=" + ] } }, - "status": "Too Many Requests" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 500, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { @@ -179664,61 +214215,121 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\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}}" ], "path": [ - "admin", - "v1", - "api", - "workspace" + "organization", + ":orgid", + "asset", + ":id" ], - "query": [ + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", + "variable": [ { - "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/documentation/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": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", "value": "" }, { - "description": "Sort By Field", - "key": "sortBy", + "description": "Resource ID of the Asset", + "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 \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\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", + "asset", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", + "variable": [ { - "description": "Sort direction", - "key": "sort", + "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": "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": "" + "description": "Resource ID of the Asset", + "key": "id", + "value": "" } - ], - "raw": "{{baseUrl}}/admin/v1/api/workspace?filter=&sortBy=&sort=&page=&pageSize=" + ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 404, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 412, "cookie": [], "header": [ { @@ -179726,61 +214337,121 @@ "value": "application/json" } ], - "name": "Resource not found", + "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 \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\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}}" ], "path": [ - "admin", - "v1", - "api", - "workspace" + "organization", + ":orgid", + "asset", + ":id" ], - "query": [ + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", + "variable": [ { - "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/documentation/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": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", "value": "" }, { - "description": "Sort By Field", - "key": "sortBy", + "description": "Resource ID of the Asset", + "key": "id", "value": "" - }, + } + ] + } + }, + "status": "Precondition Failed" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"businessAddress\": \"Rq@3X42E01\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"m-kQv\u2005IxX\u2029\",\n \"organizationId\": \"4e9BcDfa3A9CC6C7-edfC-F8F0a7a7D8dA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"channelName\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"kUSI_VM0 JiF9O\u2002uW2\\rswNC_kjWWmLjnkp_2P4-B\u2005tU\u200a6LsYDBD6EM-ZHKEJZs\",\n \"fieldKey\": \"v3-D\u180eLKtSBe7m-MA\",\n \"id\": \"\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"PJ8-OL4kGvcG\u2003rM1uDYP\u2003wkH5Xt2ok_ypo0hj\\rj2dEW6zYnNm-kGZ\u2001Doj_XmFT\",\n \"fieldKey\": \"Zp\u2002EluBWBYEF7_HTIiphkdKFaW\",\n \"id\": \"\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\"\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 \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "asset", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", + "variable": [ { - "description": "Sort direction", - "key": "sort", + "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": "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": "" + "description": "Resource ID of the Asset", + "key": "id", + "value": "" } - ], - "raw": "{{baseUrl}}/admin/v1/api/workspace?filter=&sortBy=&sort=&page=&pageSize=" + ] } }, - "status": "Not Found" + "status": "OK" }, { "_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, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { @@ -179788,102 +214459,146 @@ "value": "application/json" } ], - "name": "Ok", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"businessAddress\": \"(KVBD\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"D(P\",\n \"organizationId\": \"c1B67db6-B1d4-1ccaE6c5c26fC35Fb4ae\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"EtzUcL2jTE\u180e28B2gSsYZo-\u1680qxD-Q3aXxJWXoFfDPUtI3p14W\",\n \"fieldKey\": \"-v94TsS8\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"_uHW\u2006fjAwo0L0\",\n \"fieldKey\": \"Gx\u20025v8dlCjN5gQncx4\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\",\n \"webhookSecret\": \"\"\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}}" ], "path": [ - "admin", - "v1", - "api", - "workspace" + "organization", + ":orgid", + "asset", + ":id" ], - "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/documentation/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}}/organization/:orgid/asset/:id", + "variable": [ { - "description": "Sort By Field", - "key": "sortBy", + "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": "Sort direction", - "key": "sort", + "description": "Resource ID of the Asset", + "key": "id", "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": "Forbidden" } ] }, { - "name": "Create Workspace", + "name": "Delete specific Asset by ID", "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": "Delete an existing Asset by ID in a given organization. Validates whether the asset is associated with any flow before deletion.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace" + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", + "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 Asset", + "key": "id", + "value": "" + } + ] } }, "response": [ { "_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}", - "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": [ + { + "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", + "asset", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", + "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 Asset", + "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": 412, "cookie": [], "header": [ { @@ -179891,48 +214606,46 @@ "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", - "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": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace" + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", + "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 Asset", + "key": "id", + "value": "" + } + ] } }, - "status": "OK" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"510 NOT_EXTENDED\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "code": 409, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { @@ -179940,47 +214653,82 @@ "value": "application/json" } ], - "name": "Resource already exists", + "name": "Unauthorized Operation", "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": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace" + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", + "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 Asset", + "key": "id", + "value": "" + } + ] } }, - "status": "Conflict" + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "asset", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", + "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 Asset", + "key": "id", + "value": "" + } + ] + } + }, + "status": "No Content" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"506 VARIANT_ALSO_NEGOTIATES\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "code": 429, "cookie": [], "header": [ @@ -179989,47 +214737,45 @@ "value": "application/json" } ], - "name": "Too many requests", + "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 \"description\": \"\",\n \"name\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace" + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", + "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 Asset", + "key": "id", + "value": "" + } + ] } }, "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"408 REQUEST_TIMEOUT\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "code": 404, "cookie": [], "header": [ @@ -180038,48 +214784,46 @@ "value": "application/json" } ], - "name": "Resource not found", + "name": "Resource not found or URI is invalid", "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": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace" + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", + "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 Asset", + "key": "id", + "value": "" + } + ] } }, "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"status\": \"301 MOVED_PERMANENTLY\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\"\n}", - "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": [ { @@ -180087,54 +214831,46 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Operation is forbidden", "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": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "v1", - "api", - "workspace" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace" + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", + "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 Asset", + "key": "id", + "value": "" + } + ] } }, - "status": "Internal Server Error" + "status": "Forbidden" } ] - } - ], - "name": "Journey - Workspace management API" - }, - { - "description": "Operations for managing Do Not Contact (DNC) lists and phone number entries", - "item": [ + }, { - "name": "Add Phone Number to DNC List", + "name": "Partially update Asset by ID", "request": { "body": { "mode": "raw", @@ -180144,9 +214880,9 @@ "language": "json" } }, - "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + "raw": "{\n \"valueType\": \"ARRAY\"\n}" }, - "description": "Adds a phone number to the specified Do Not Contact (DNC) list. This operation helps ensure compliance with applicable rules & regulations by preventing outbound calls to specific numbers.\n\n**Note:** Phone numbers must be in E.164 format (e.g., +1234567890). Duplicate entries will be rejected with a 409 error.", + "description": "Partially update Asset by ID in a given organization. Supported only for CUSTOM_MESSAGING assets. Send only the fields to change; absent fields retain their current values. webhookConfig is optional; omit it to keep the existing credentials. For WORK_ITEM assets, use PUT instead.", "header": [ { "key": "Content-Type", @@ -180154,27 +214890,31 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", "variable": [ { - "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName", - "value": "nFT" + "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 Asset", + "key": "id", + "value": "" } ] } @@ -180182,8 +214922,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"phoneNumber\": \"+655944\",\n \"source\": \"\",\n \"addedDate\": \"\",\n \"addedBy\": \"\",\n \"reason\": \"\",\n \"lastModified\": \"\"\n}", - "code": 201, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { @@ -180191,7 +214931,7 @@ "value": "application/json" } ], - "name": "Phone number successfully added to the DNC list", + "name": "Resource not found or URI is invalid", "originalRequest": { "body": { "mode": "raw", @@ -180201,7 +214941,7 @@ "language": "json" } }, - "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + "raw": "{\n \"valueType\": \"ARRAY\"\n}" }, "header": [ { @@ -180213,33 +214953,38 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", "variable": [ { - "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "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 Asset", + "key": "id", + "value": "" } ] } }, - "status": "Created" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 403,\n \"message\": \"\",\n \"trackingId\": \"\"\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": [ { @@ -180247,7 +214992,7 @@ "value": "application/json" } ], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed. User lacks required permissions to manage DNC lists.", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -180257,7 +215002,7 @@ "language": "json" } }, - "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + "raw": "{\n \"valueType\": \"ARRAY\"\n}" }, "header": [ { @@ -180269,41 +215014,46 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", "variable": [ { - "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "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 Asset", + "key": "id", + "value": "" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"code\": 504,\n \"message\": \"\",\n \"trackingId\": \"\",\n \"details\": {\n \"timeoutDuration\": \"\",\n \"upstreamService\": \"\",\n \"retryRecommended\": \"\"\n }\n}", - "code": 504, + "_postman_previewlanguage": "text", + "body": "{\n \"businessAddress\": \"Rq@3X42E01\",\n \"channelId\": \"\",\n \"channelType\": \"EMAIL\",\n \"name\": \"m-kQv\u2005IxX\u2029\",\n \"organizationId\": \"4e9BcDfa3A9CC6C7-edfC-F8F0a7a7D8dA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"channelName\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"kUSI_VM0 JiF9O\u2002uW2\\rswNC_kjWWmLjnkp_2P4-B\u2005tU\u200a6LsYDBD6EM-ZHKEJZs\",\n \"fieldKey\": \"v3-D\u180eLKtSBe7m-MA\",\n \"id\": \"\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"PJ8-OL4kGvcG\u2003rM1uDYP\u2003wkH5Xt2ok_ypo0hj\\rj2dEW6zYnNm-kGZ\u2001Doj_XmFT\",\n \"fieldKey\": \"Zp\u2002EluBWBYEF7_HTIiphkdKFaW\",\n \"id\": \"\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -180313,7 +215063,7 @@ "language": "json" } }, - "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + "raw": "{\n \"valueType\": \"ARRAY\"\n}" }, "header": [ { @@ -180322,53 +215072,49 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", "variable": [ { - "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "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 Asset", + "key": "id", + "value": "" } ] } }, - "status": "Gateway Timeout" + "status": "OK" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 429,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", - "code": 429, + "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" - }, - { - "description": { - "content": "Number of seconds to wait before retrying", - "type": "text/plain" - }, - "disabled": false, - "key": "Retry-After", - "value": "" } ], - "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": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -180378,7 +215124,7 @@ "language": "json" } }, - "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + "raw": "{\n \"valueType\": \"ARRAY\"\n}" }, "header": [ { @@ -180390,33 +215136,38 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", "variable": [ { - "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "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 Asset", + "key": "id", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 1002,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", - "code": 400, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { @@ -180424,7 +215175,7 @@ "value": "application/json" } ], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -180434,7 +215185,7 @@ "language": "json" } }, - "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + "raw": "{\n \"valueType\": \"ARRAY\"\n}" }, "header": [ { @@ -180446,33 +215197,38 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", "variable": [ { - "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "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 Asset", + "key": "id", + "value": "" } ] } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 401,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", - "code": 401, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { @@ -180480,7 +215236,7 @@ "value": "application/json" } ], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -180490,7 +215246,7 @@ "language": "json" } }, - "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + "raw": "{\n \"valueType\": \"ARRAY\"\n}" }, "header": [ { @@ -180502,33 +215258,38 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", "variable": [ { - "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "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 Asset", + "key": "id", + "value": "" } ] } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 503,\n \"message\": \"\",\n \"trackingId\": \"\",\n \"details\": {\n \"maintenanceWindow\": {\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n \"retryAfter\": \"\"\n }\n}", - "code": 503, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { @@ -180536,7 +215297,7 @@ "value": "application/json" } ], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -180546,7 +215307,7 @@ "language": "json" } }, - "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" + "raw": "{\n \"valueType\": \"ARRAY\"\n}" }, "header": [ { @@ -180558,33 +215319,95 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber" + "organization", + ":orgid", + "asset", + ":id" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/asset/:id", "variable": [ { - "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "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 Asset", + "key": "id", + "value": "" } ] } }, - "status": "Service Unavailable" - }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "List references for a specific Asset", + "request": { + "description": "Retrieve a list of all entities that have reference to an existing Asset by ID in a given organization. For example, Entry Points.", + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "asset", + ":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/asset/: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 \"code\": 502,\n \"message\": \"\",\n \"trackingId\": \"\",\n \"details\": {\n \"upstreamService\": \"\",\n \"retryRecommended\": \"\"\n }\n}", - "code": 502, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { @@ -180592,55 +215415,64 @@ "value": "application/json" } ], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber" + "organization", + ":orgid", + "asset", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "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/asset/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { - "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "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": "" } ] } }, - "status": "Bad Gateway" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 1005,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", - "code": 404, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { @@ -180648,111 +215480,129 @@ "value": "application/json" } ], - "name": "Not Found: The specified DNC list does not exist or the user does not have access to it.", + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber" + "organization", + ":orgid", + "asset", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "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/asset/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { - "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "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": "" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"code\": 409,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"a8dFD929ea07779ED5bC57C3C2BDA4dB\",\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 },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Conflict: The phone number already exists in the specified DNC list.", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber" + "organization", + ":orgid", + "asset", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "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/asset/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { - "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "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": "" } ] } }, - "status": "Conflict" + "status": "OK" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 1006,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", - "code": 500, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { @@ -180760,113 +215610,72 @@ "value": "application/json" } ], - "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 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 \"phoneNumber\": \"+780508\",\n \"source\": \"\",\n \"reason\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber" + "organization", + ":orgid", + "asset", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", + "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/asset/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { - "description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "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": "" } ] } }, - "status": "Internal Server Error" - } - ] - }, - { - "name": "Get Phone Number from DNC List", - "request": { - "description": "Retrieves details of a specific phone number from the specified Do Not Contact (DNC) list. This operation allows you to check if a number is present in the list and view associated metadata.\n\n**Note:** Phone numbers must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" - ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", - "variable": [ - { - "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName", - "value": "nFT" - }, - { - "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber", - "value": "+8342" - } - ] - } - }, - "response": [ + "status": "Too Many Requests" + }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 429,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", - "code": 429, + "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" - }, - { - "description": { - "content": "Number of seconds to wait before retrying", - "type": "text/plain" - }, - "disabled": false, - "key": "Retry-After", - "value": "" } ], - "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": "Operation is forbidden", "originalRequest": { "header": [ { @@ -180880,32 +215689,50 @@ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" + "organization", + ":orgid", + "asset", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "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/asset/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { - "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "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 phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 1002,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", - "code": 400, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { @@ -180913,7 +215740,7 @@ "value": "application/json" } ], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -180927,32 +215754,136 @@ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" + "organization", + ":orgid", + "asset", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "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/asset/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { - "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "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 phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Bad Request" - }, + "status": "Not Found" + } + ] + }, + { + "name": "List Assets", + "request": { + "description": "Retrieve a list of Assets in a given organization. Supports pagination metadata. Set includeChannelName to true to include the channel name in the response. Set excludeEPAssociated to true to return only assets that are not associated with any Entry Point.", + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v2", + "asset" + ], + "query": [ + { + "description": "Filter expression", + "key": "filter", + "value": "" + }, + { + "description": "Supported attributes", + "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": "Sortable properties", + "key": "sort", + "value": "name" + }, + { + "description": "Include count", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "Include channel name in the response.", + "key": "includeChannelName", + "value": "false" + }, + { + "description": "When true, return only assets that are not associated with any Entry Point.", + "key": "excludeEPAssociated", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/asset?filter=&attributes=&search=&page=0&pageSize=100&sort=name&includeCount=false&singleObjectResponse=false&includeChannelName=false&excludeEPAssociated=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": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 1005,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", - "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": [ { @@ -180960,7 +215891,7 @@ "value": "application/json" } ], - "name": "Not Found: The specified DNC list does not exist, the phone number is not found in the list, or the user does not have access to it.", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -180974,78 +215905,78 @@ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" + "organization", + ":orgid", + "v2", + "asset" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", - "variable": [ + "query": [ { - "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "description": "Filter expression", + "key": "filter", + "value": "" }, { - "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "description": "Supported attributes", + "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": "Sortable properties", + "key": "sort", + "value": "name" + }, + { + "description": "Include count", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "Include channel name in the response.", + "key": "includeChannelName", + "value": "false" + }, + { + "description": "When true, return only assets that are not associated with any Entry Point.", + "key": "excludeEPAssociated", + "value": "false" } - ] - } - }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"code\": 502,\n \"message\": \"\",\n \"trackingId\": \"\",\n \"details\": {\n \"upstreamService\": \"\",\n \"retryRecommended\": \"\"\n }\n}", - "code": 502, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "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" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/v2/asset?filter=&attributes=&search=&page=0&pageSize=100&sort=name&includeCount=false&singleObjectResponse=false&includeChannelName=false&excludeEPAssociated=false", "variable": [ { - "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" - }, - { - "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "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": "Bad Gateway" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 1006,\n \"message\": \"\",\n \"trackingId\": \"\"\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": [ @@ -181054,7 +215985,7 @@ "value": "application/json" } ], - "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": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -181068,78 +215999,78 @@ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" + "organization", + ":orgid", + "v2", + "asset" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", - "variable": [ + "query": [ { - "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "description": "Filter expression", + "key": "filter", + "value": "" }, { - "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "description": "Supported attributes", + "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": "Sortable properties", + "key": "sort", + "value": "name" + }, + { + "description": "Include count", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "Include channel name in the response.", + "key": "includeChannelName", + "value": "false" + }, + { + "description": "When true, return only assets that are not associated with any Entry Point.", + "key": "excludeEPAssociated", + "value": "false" } - ] - } - }, - "status": "Internal Server Error" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"code\": 503,\n \"message\": \"\",\n \"trackingId\": \"\",\n \"details\": {\n \"maintenanceWindow\": {\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n \"retryAfter\": \"\"\n }\n}", - "code": 503, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/v2/asset?filter=&attributes=&search=&page=0&pageSize=100&sort=name&includeCount=false&singleObjectResponse=false&includeChannelName=false&excludeEPAssociated=false", "variable": [ { - "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" - }, - { - "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "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": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 401,\n \"message\": \"\",\n \"trackingId\": \"\"\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": [ @@ -181148,7 +216079,7 @@ "value": "application/json" } ], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -181162,22 +216093,69 @@ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" + "organization", + ":orgid", + "v2", + "asset" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", - "variable": [ + "query": [ { - "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "description": "Filter expression", + "key": "filter", + "value": "" }, { - "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "description": "Supported attributes", + "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": "Sortable properties", + "key": "sort", + "value": "name" + }, + { + "description": "Include count", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "Include channel name in the response.", + "key": "includeChannelName", + "value": "false" + }, + { + "description": "When true, return only assets that are not associated with any Entry Point.", + "key": "excludeEPAssociated", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/asset?filter=&attributes=&search=&page=0&pageSize=100&sort=name&includeCount=false&singleObjectResponse=false&includeChannelName=false&excludeEPAssociated=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": "" } ] } @@ -181185,22 +216163,22 @@ "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"code\": 504,\n \"message\": \"\",\n \"trackingId\": \"\",\n \"details\": {\n \"timeoutDuration\": \"\",\n \"upstreamService\": \"\",\n \"retryRecommended\": \"\"\n }\n}", - "code": 504, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"data\": [\n {\n \"businessAddress\": \"\",\n \"channelId\": \"\",\n \"channelType\": \"WORK_ITEM\",\n \"name\": \"\\fx\",\n \"organizationId\": \"6aCDfe4FF96C-839CaCE0-BC6cE997aBEE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"channelName\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"Z\ufeffx\u200973UfQ\ufeffiAJpeevY8sLw0d9rL9UzTWsT4ZMvd\",\n \"fieldKey\": \"O0GG2N1DGh4MchXD1sEd\u2008DfXE1HYXugn\u2006LoDEKPP7p\u202fGT7fdqW0D2Z\",\n \"id\": \"\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"AxJAj-M PSIr\u2000JqhQu 2m9s7gzpLPr\u2008HpJG4wuIzOgIFG2Uz6x5G\\fRVu-8Bjavcdg\u20080osuwReCop93o2\",\n \"fieldKey\": \"ZEeQ3\u2028U3_p\u00a0-8s5AA-HQ-r\",\n \"id\": \"\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"businessAddress\": \"NKK\",\n \"channelId\": \"\",\n \"channelType\": \"VIDEO\",\n \"name\": \"CY\u202fY2\u2001\",\n \"organizationId\": \"7F26fD7a-32efCFf94Ac3bdDb5edcdECF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"channelName\": \"\",\n \"dataSchema\": [\n {\n \"displayName\": \"ROTQ\",\n \"fieldKey\": \"j\u2001wCj8UKF1Al665\u2007Z7DwI2PCckz26FHPmAQwkWHC39E_Bw\",\n \"id\": \"\",\n \"isViewable\": false,\n \"isRequired\": false\n },\n {\n \"displayName\": \"2ziulAD\ufefflIsd9Qq\u1680eecpiIVubD5NNq\\n7v8vHfTp9io4k84v6Xymt1i9e\u1680usuls9pggbnBRx\ufeffQeZKDZ\",\n \"fieldKey\": \"FpW\u202flFN6TQNG\u2002hti_\u2005N2titrGTUi\",\n \"id\": \"\",\n \"isViewable\": false,\n \"isRequired\": false\n }\n ],\n \"webhookConfig\": {\n \"webhookUrl\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -181209,32 +216187,79 @@ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" + "organization", + ":orgid", + "v2", + "asset" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", - "variable": [ + "query": [ { - "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "description": "Filter expression", + "key": "filter", + "value": "" }, { - "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "description": "Supported attributes", + "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": "Sortable properties", + "key": "sort", + "value": "name" + }, + { + "description": "Include count", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "Include channel name in the response.", + "key": "includeChannelName", + "value": "false" + }, + { + "description": "When true, return only assets that are not associated with any Entry Point.", + "key": "excludeEPAssociated", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/asset?filter=&attributes=&search=&page=0&pageSize=100&sort=name&includeCount=false&singleObjectResponse=false&includeChannelName=false&excludeEPAssociated=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": "Gateway Timeout" + "status": "OK" }, { "_postman_previewlanguage": "json", - "body": "{\n \"phoneNumber\": \"+655944\",\n \"source\": \"\",\n \"addedDate\": \"\",\n \"addedBy\": \"\",\n \"reason\": \"\",\n \"lastModified\": \"\"\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": [ { @@ -181242,7 +216267,7 @@ "value": "application/json" } ], - "name": "Phone number details successfully retrieved from the DNC list", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -181256,32 +216281,79 @@ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" + "organization", + ":orgid", + "v2", + "asset" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", - "variable": [ + "query": [ { - "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "description": "Filter expression", + "key": "filter", + "value": "" }, { - "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "description": "Supported attributes", + "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": "Sortable properties", + "key": "sort", + "value": "name" + }, + { + "description": "Include count", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "Include channel name in the response.", + "key": "includeChannelName", + "value": "false" + }, + { + "description": "When true, return only assets that are not associated with any Entry Point.", + "key": "excludeEPAssociated", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/asset?filter=&attributes=&search=&page=0&pageSize=100&sort=name&includeCount=false&singleObjectResponse=false&includeChannelName=false&excludeEPAssociated=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": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 403,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", - "code": 403, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { @@ -181289,7 +216361,7 @@ "value": "application/json" } ], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed. User lacks required permissions to view DNC lists.", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -181303,120 +216375,186 @@ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" + "organization", + ":orgid", + "v2", + "asset" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", - "variable": [ + "query": [ { - "description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" + "description": "Filter expression", + "key": "filter", + "value": "" }, { - "description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "description": "Supported attributes", + "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": "Sortable properties", + "key": "sort", + "value": "name" + }, + { + "description": "Include count", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "Include channel name in the response.", + "key": "includeChannelName", + "value": "false" + }, + { + "description": "When true, return only assets that are not associated with any Entry Point.", + "key": "excludeEPAssociated", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/asset?filter=&attributes=&search=&page=0&pageSize=100&sort=name&includeCount=false&singleObjectResponse=false&includeChannelName=false&excludeEPAssociated=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" + "status": "Not Found" } ] - }, + } + ], + "name": "Asset" + }, + { + "item": [ { - "name": "Remove Phone Number from DNC List", + "name": "Create a new Channel", "request": { - "description": "Removes a phone number from the specified Do Not Contact (DNC) list. This operation allows administrators to remove numbers that should no longer be blocked from receiving calls.\n\n**Note:** Phone numbers must be URL-encoded and in E.164 format (e.g., +1234567890 for +1234567890). If the number doesn't exist in the list, a 404 error will be returned.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"logoFileInfo\": {\n \"channelType\": \"CUSTOM_MESSAGING\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"B\\f\\f\u2000\u180e\",\n \"organizationId\": \"719Ba941CDCE-D3fE-13bb-14CFEAc97b31\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"dotx\",\n \"rtf\"\n ],\n \"key_1\": [\n \"webp\",\n \"ppam\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"logoFile\": \"\"\n}" + }, + "description": "Create a new Channel in a given organization. Supports custom channels for work items.", "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" + "organization", + ":orgid", + "channel" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/channel", "variable": [ { - "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName", - "value": "nFT" - }, - { - "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber", - "value": "+8342" + "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 \"code\": 1006,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": "{\n \"channelType\": \"CUSTOM_MESSAGING\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"3\ufeff\",\n \"organizationId\": \"87BEEdd5-ddcd-0E63E1d1AB3f07232def\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"logoUrl\": \"\",\n \"logoUrlVersioned\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"webp\",\n \"jpeg\"\n ],\n \"key_1\": [\n \"pdfxml\",\n \"bmp\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 201, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "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": "Created", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"logoFileInfo\": {\n \"channelType\": \"CUSTOM_MESSAGING\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"B\\f\\f\u2000\u180e\",\n \"organizationId\": \"719Ba941CDCE-D3fE-13bb-14CFEAc97b31\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"dotx\",\n \"rtf\"\n ],\n \"key_1\": [\n \"webp\",\n \"ppam\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"logoFile\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" + "organization", + ":orgid", + "channel" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/channel", "variable": [ { - "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" - }, - { - "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "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": "Internal Server Error" + "status": "Created" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 403,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", - "code": 403, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { @@ -181424,46 +216562,54 @@ "value": "application/json" } ], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed. User lacks required permissions to manage DNC lists.", + "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 \"logoFileInfo\": {\n \"channelType\": \"CUSTOM_MESSAGING\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"B\\f\\f\u2000\u180e\",\n \"organizationId\": \"719Ba941CDCE-D3fE-13bb-14CFEAc97b31\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"dotx\",\n \"rtf\"\n ],\n \"key_1\": [\n \"webp\",\n \"ppam\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"logoFile\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" + "organization", + ":orgid", + "channel" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/channel", "variable": [ { - "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" - }, - { - "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "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" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 502,\n \"message\": \"\",\n \"trackingId\": \"\",\n \"details\": {\n \"upstreamService\": \"\",\n \"retryRecommended\": \"\"\n }\n}", - "code": 502, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { @@ -181471,46 +216617,54 @@ "value": "application/json" } ], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"logoFileInfo\": {\n \"channelType\": \"CUSTOM_MESSAGING\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"B\\f\\f\u2000\u180e\",\n \"organizationId\": \"719Ba941CDCE-D3fE-13bb-14CFEAc97b31\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"dotx\",\n \"rtf\"\n ],\n \"key_1\": [\n \"webp\",\n \"ppam\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"logoFile\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" + "organization", + ":orgid", + "channel" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/channel", "variable": [ { - "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" - }, - { - "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "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": "Bad Gateway" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 503,\n \"message\": \"\",\n \"trackingId\": \"\",\n \"details\": {\n \"maintenanceWindow\": {\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n \"retryAfter\": \"\"\n }\n}", - "code": 503, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { @@ -181518,46 +216672,54 @@ "value": "application/json" } ], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"logoFileInfo\": {\n \"channelType\": \"CUSTOM_MESSAGING\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"B\\f\\f\u2000\u180e\",\n \"organizationId\": \"719Ba941CDCE-D3fE-13bb-14CFEAc97b31\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"dotx\",\n \"rtf\"\n ],\n \"key_1\": [\n \"webp\",\n \"ppam\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"logoFile\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" + "organization", + ":orgid", + "channel" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/channel", "variable": [ { - "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" - }, - { - "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "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": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 401,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", - "code": 401, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { @@ -181565,138 +216727,53 @@ "value": "application/json" } ], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"logoFileInfo\": {\n \"channelType\": \"CUSTOM_MESSAGING\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"B\\f\\f\u2000\u180e\",\n \"organizationId\": \"719Ba941CDCE-D3fE-13bb-14CFEAc97b31\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"dotx\",\n \"rtf\"\n ],\n \"key_1\": [\n \"webp\",\n \"ppam\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"logoFile\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" - } - ], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" - ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", - "variable": [ - { - "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" - }, - { - "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" - } - ] - } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"code\": 429,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", - "code": 429, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "description": { - "content": "Number of seconds to wait before retrying", - "type": "text/plain" }, - "disabled": false, - "key": "Retry-After", - "value": "" - } - ], - "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": [ { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" - ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", - "variable": [ - { - "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" - }, - { - "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" - } - ] - } - }, - "status": "Too Many Requests" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 204, - "cookie": [], - "header": [], - "name": "Phone number successfully removed from the DNC list. No content is returned.", - "originalRequest": { - "header": [], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" + "organization", + ":orgid", + "channel" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/channel", "variable": [ { - "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" - }, - { - "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "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": "No Content" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 1002,\n \"message\": \"\",\n \"trackingId\": \"\"\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": [ @@ -181705,36 +216782,44 @@ "value": "application/json" } ], - "name": "Bad Request: The request was invalid or cannot be otherwise 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", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"logoFileInfo\": {\n \"channelType\": \"CUSTOM_MESSAGING\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"B\\f\\f\u2000\u180e\",\n \"organizationId\": \"719Ba941CDCE-D3fE-13bb-14CFEAc97b31\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"dotx\",\n \"rtf\"\n ],\n \"key_1\": [\n \"webp\",\n \"ppam\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"logoFile\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" + "organization", + ":orgid", + "channel" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/channel", "variable": [ { - "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" - }, - { - "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" } ] } @@ -181743,8 +216828,8 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": 504,\n \"message\": \"\",\n \"trackingId\": \"\",\n \"details\": {\n \"timeoutDuration\": \"\",\n \"upstreamService\": \"\",\n \"retryRecommended\": \"\"\n }\n}", - "code": 504, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 409, "cookie": [], "header": [ { @@ -181752,98 +216837,54 @@ "value": "application/json" } ], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Similar entity is already present", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"logoFileInfo\": {\n \"channelType\": \"CUSTOM_MESSAGING\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"B\\f\\f\u2000\u180e\",\n \"organizationId\": \"719Ba941CDCE-D3fE-13bb-14CFEAc97b31\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"dotx\",\n \"rtf\"\n ],\n \"key_1\": [\n \"webp\",\n \"ppam\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"logoFile\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" - } - ], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" - ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", - "variable": [ - { - "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" - }, - { - "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" - } - ] - } - }, - "status": "Gateway Timeout" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"code\": 1005,\n \"message\": \"\",\n \"trackingId\": \"\"\n}", - "code": 404, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Not Found: The specified DNC list does not exist, the phone number is not found in the list, or the user does not have access to it.", - "originalRequest": { - "header": [ + }, { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "dncList", - ":dncListName", - "phoneNumber", - ":phoneNumber" + "organization", + ":orgid", + "channel" ], - "raw": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", + "raw": "{{baseUrl}}/organization/:orgid/channel", "variable": [ { - "description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.", - "key": "dncListName" - }, - { - "description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).", - "key": "phoneNumber" + "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": "Not Found" + "status": "Conflict" } ] - } - ], - "name": "DNC Management" - }, - { - "item": [ + }, { - "name": "Create a new Resource Collection", + "name": "Bulk save Channels", "request": { "body": { "mode": "raw", @@ -181853,9 +216894,9 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"channelType\": \"OTHERS\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"62\",\n \"organizationId\": \"8819EfBE8b6d9d5F-d6B7-5b2bdEcEf59c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"xlt\",\n \"xml\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"channelType\": \"FAX\",\n \"logoType\": \"LOGO_URL\",\n \"name\": \"Xzq- A\u2007nVQ\",\n \"organizationId\": \"9DCE9fdFad7F0182-7Fe4CEb78Daa6D8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"flv\",\n \"msg\"\n ],\n \"key_1\": [\n \"mht\",\n \"eml\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Create a new resource collection in a given organization.", + "description": "Create, Update or delete Channels in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -181874,9 +216915,10 @@ "path": [ "organization", ":orgid", - "resource-collection" + "channel", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection", + "raw": "{{baseUrl}}/organization/:orgid/channel/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -181890,7 +216932,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": [ { @@ -181898,7 +216940,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -181908,7 +216950,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"channelType\": \"OTHERS\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"62\",\n \"organizationId\": \"8819EfBE8b6d9d5F-d6B7-5b2bdEcEf59c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"xlt\",\n \"xml\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"channelType\": \"FAX\",\n \"logoType\": \"LOGO_URL\",\n \"name\": \"Xzq- A\u2007nVQ\",\n \"organizationId\": \"9DCE9fdFad7F0182-7Fe4CEb78Daa6D8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"flv\",\n \"msg\"\n ],\n \"key_1\": [\n \"mht\",\n \"eml\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -181928,18 +216970,20 @@ "path": [ "organization", ":orgid", - "resource-collection" + "channel", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection", + "raw": "{{baseUrl}}/organization/:orgid/channel/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" + "key": "orgid", + "value": "" } ] } }, - "status": "Conflict" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -181962,7 +217006,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"channelType\": \"OTHERS\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"62\",\n \"organizationId\": \"8819EfBE8b6d9d5F-d6B7-5b2bdEcEf59c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"xlt\",\n \"xml\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"channelType\": \"FAX\",\n \"logoType\": \"LOGO_URL\",\n \"name\": \"Xzq- A\u2007nVQ\",\n \"organizationId\": \"9DCE9fdFad7F0182-7Fe4CEb78Daa6D8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"flv\",\n \"msg\"\n ],\n \"key_1\": [\n \"mht\",\n \"eml\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -181982,13 +217026,15 @@ "path": [ "organization", ":orgid", - "resource-collection" + "channel", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection", + "raw": "{{baseUrl}}/organization/:orgid/channel/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" + "key": "orgid", + "value": "" } ] } @@ -182016,7 +217062,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"channelType\": \"OTHERS\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"62\",\n \"organizationId\": \"8819EfBE8b6d9d5F-d6B7-5b2bdEcEf59c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"xlt\",\n \"xml\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"channelType\": \"FAX\",\n \"logoType\": \"LOGO_URL\",\n \"name\": \"Xzq- A\u2007nVQ\",\n \"organizationId\": \"9DCE9fdFad7F0182-7Fe4CEb78Daa6D8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"flv\",\n \"msg\"\n ],\n \"key_1\": [\n \"mht\",\n \"eml\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -182036,13 +217082,15 @@ "path": [ "organization", ":orgid", - "resource-collection" + "channel", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection", + "raw": "{{baseUrl}}/organization/:orgid/channel/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" + "key": "orgid", + "value": "" } ] } @@ -182052,7 +217100,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": [ { @@ -182060,7 +217108,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -182070,7 +217118,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"channelType\": \"OTHERS\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"62\",\n \"organizationId\": \"8819EfBE8b6d9d5F-d6B7-5b2bdEcEf59c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"xlt\",\n \"xml\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"channelType\": \"FAX\",\n \"logoType\": \"LOGO_URL\",\n \"name\": \"Xzq- A\u2007nVQ\",\n \"organizationId\": \"9DCE9fdFad7F0182-7Fe4CEb78Daa6D8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"flv\",\n \"msg\"\n ],\n \"key_1\": [\n \"mht\",\n \"eml\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -182090,31 +217138,33 @@ "path": [ "organization", ":orgid", - "resource-collection" + "channel", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection", + "raw": "{{baseUrl}}/organization/:orgid/channel/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" + "key": "orgid", + "value": "" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"name\": \"4\u00a02lgM\u2003\u2008t\",\n \"organizationId\": \"4c89048aeF9eB455-FbFC2d9fC96537b6\",\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}", - "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", @@ -182124,7 +217174,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"channelType\": \"OTHERS\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"62\",\n \"organizationId\": \"8819EfBE8b6d9d5F-d6B7-5b2bdEcEf59c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"xlt\",\n \"xml\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"channelType\": \"FAX\",\n \"logoType\": \"LOGO_URL\",\n \"name\": \"Xzq- A\u2007nVQ\",\n \"organizationId\": \"9DCE9fdFad7F0182-7Fe4CEb78Daa6D8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"flv\",\n \"msg\"\n ],\n \"key_1\": [\n \"mht\",\n \"eml\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -182133,7 +217183,7 @@ }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -182144,23 +217194,25 @@ "path": [ "organization", ":orgid", - "resource-collection" + "channel", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection", + "raw": "{{baseUrl}}/organization/:orgid/channel/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" + "key": "orgid", + "value": "" } ] } }, - "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": 500, + "code": 400, "cookie": [], "header": [ { @@ -182168,7 +217220,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", @@ -182178,7 +217230,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"channelType\": \"OTHERS\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"62\",\n \"organizationId\": \"8819EfBE8b6d9d5F-d6B7-5b2bdEcEf59c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"xlt\",\n \"xml\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"channelType\": \"FAX\",\n \"logoType\": \"LOGO_URL\",\n \"name\": \"Xzq- A\u2007nVQ\",\n \"organizationId\": \"9DCE9fdFad7F0182-7Fe4CEb78Daa6D8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"flv\",\n \"msg\"\n ],\n \"key_1\": [\n \"mht\",\n \"eml\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -182198,31 +217250,33 @@ "path": [ "organization", ":orgid", - "resource-collection" + "channel", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection", + "raw": "{{baseUrl}}/organization/:orgid/channel/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" + "key": "orgid", + "value": "" } ] } }, - "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, + "_postman_previewlanguage": "text", + "body": "{\n \"items\": [\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 \"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", @@ -182232,7 +217286,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"channelType\": \"OTHERS\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"62\",\n \"organizationId\": \"8819EfBE8b6d9d5F-d6B7-5b2bdEcEf59c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"xlt\",\n \"xml\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"channelType\": \"FAX\",\n \"logoType\": \"LOGO_URL\",\n \"name\": \"Xzq- A\u2007nVQ\",\n \"organizationId\": \"9DCE9fdFad7F0182-7Fe4CEb78Daa6D8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"flv\",\n \"msg\"\n ],\n \"key_1\": [\n \"mht\",\n \"eml\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -182241,7 +217295,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -182252,46 +217306,34 @@ "path": [ "organization", ":orgid", - "resource-collection" + "channel", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection", + "raw": "{{baseUrl}}/organization/:orgid/channel/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" + "key": "orgid", + "value": "" } ] } }, - "status": "Bad Request" + "status": "Multi-Status (WebDAV) (RFC 4918)" } ] }, { - "name": "Bulk partial update Resource Collections", + "name": "Get specific Channel by ID", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"53e3dC0A6d5b-1fe9-D13d-e6dc01A8Ba9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"C947242F-c9FaA753-2Feb376C3a3Da628\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "description": "Update some or all properties for resource collections in bulk for a given organization.", + "description": "Retrieve an existing Channel by ID in a given organization. Set includeLogoUrlVersioned to true to include logoUrlVersioned in the response.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -182299,15 +217341,27 @@ "path": [ "organization", ":orgid", - "resource-collection", - "bulk" + "channel", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/bulk", + "query": [ + { + "description": "Include logoUrlVersioned in the response.", + "key": "includeLogoUrlVersioned", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/channel/:id?includeLogoUrlVersioned=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 Channel", + "key": "id", + "value": "" } ] } @@ -182326,27 +217380,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 \"organizationId\": \"53e3dC0A6d5b-1fe9-D13d-e6dc01A8Ba9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"C947242F-c9FaA753-2Feb376C3a3Da628\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -182354,14 +217394,27 @@ "path": [ "organization", ":orgid", - "resource-collection", - "bulk" + "channel", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/bulk", + "query": [ + { + "description": "Include logoUrlVersioned in the response.", + "key": "includeLogoUrlVersioned", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/channel/:id?includeLogoUrlVersioned=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": "" + }, + { + "description": "Resource ID of the Channel", + "key": "id", + "value": "" } ] } @@ -182369,39 +217422,25 @@ "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 \"channelType\": \"CUSTOM_MESSAGING\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"3\ufeff\",\n \"organizationId\": \"87BEEdd5-ddcd-0E63E1d1AB3f07232def\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"logoUrl\": \"\",\n \"logoUrlVersioned\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"webp\",\n \"jpeg\"\n ],\n \"key_1\": [\n \"pdfxml\",\n \"bmp\"\n ]\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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"53e3dC0A6d5b-1fe9-D13d-e6dc01A8Ba9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"C947242F-c9FaA753-2Feb376C3a3Da628\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -182409,19 +217448,32 @@ "path": [ "organization", ":orgid", - "resource-collection", - "bulk" + "channel", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/bulk", + "query": [ + { + "description": "Include logoUrlVersioned in the response.", + "key": "includeLogoUrlVersioned", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/channel/:id?includeLogoUrlVersioned=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": "" + }, + { + "description": "Resource ID of the Channel", + "key": "id", + "value": "" } ] } }, - "status": "Forbidden" + "status": "OK" }, { "_postman_previewlanguage": "json", @@ -182436,27 +217488,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 \"organizationId\": \"53e3dC0A6d5b-1fe9-D13d-e6dc01A8Ba9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"C947242F-c9FaA753-2Feb376C3a3Da628\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -182464,79 +217502,37 @@ "path": [ "organization", ":orgid", - "resource-collection", - "bulk" + "channel", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/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": "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\": \"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": "Include logoUrlVersioned in the response.", + "key": "includeLogoUrlVersioned", + "value": "false" } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"53e3dC0A6d5b-1fe9-D13d-e6dc01A8Ba9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"C947242F-c9FaA753-2Feb376C3a3Da628\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "PATCH", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "resource-collection", - "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/bulk", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id?includeLogoUrlVersioned=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": "" + }, + { + "description": "Resource ID of the Channel", + "key": "id", + "value": "" } ] } }, - "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": 400, + "code": 403, "cookie": [], "header": [ { @@ -182544,29 +217540,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 \"organizationId\": \"53e3dC0A6d5b-1fe9-D13d-e6dc01A8Ba9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"C947242F-c9FaA753-2Feb376C3a3Da628\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -182574,19 +217556,32 @@ "path": [ "organization", ":orgid", - "resource-collection", - "bulk" + "channel", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/bulk", + "query": [ + { + "description": "Include logoUrlVersioned in the response.", + "key": "includeLogoUrlVersioned", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/channel/:id?includeLogoUrlVersioned=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": "" + }, + { + "description": "Resource ID of the Channel", + "key": "id", + "value": "" } ] } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -182601,27 +217596,13 @@ ], "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"53e3dC0A6d5b-1fe9-D13d-e6dc01A8Ba9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"C947242F-c9FaA753-2Feb376C3a3Da628\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -182629,14 +217610,27 @@ "path": [ "organization", ":orgid", - "resource-collection", - "bulk" + "channel", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/bulk", + "query": [ + { + "description": "Include logoUrlVersioned in the response.", + "key": "includeLogoUrlVersioned", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/channel/:id?includeLogoUrlVersioned=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": "" + }, + { + "description": "Resource ID of the Channel", + "key": "id", + "value": "" } ] } @@ -182656,27 +217650,13 @@ ], "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 \"organizationId\": \"53e3dC0A6d5b-1fe9-D13d-e6dc01A8Ba9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"C947242F-c9FaA753-2Feb376C3a3Da628\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -182684,14 +217664,27 @@ "path": [ "organization", ":orgid", - "resource-collection", - "bulk" + "channel", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/bulk", + "query": [ + { + "description": "Include logoUrlVersioned in the response.", + "key": "includeLogoUrlVersioned", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/channel/:id?includeLogoUrlVersioned=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": "" + }, + { + "description": "Resource ID of the Channel", + "key": "id", + "value": "" } ] } @@ -182701,30 +217694,23 @@ ] }, { - "name": "Update resource with default resource collection", + "name": "Update specific Channel by ID", "request": { "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"resourceId\": \"\",\n \"resourceType\": \"\",\n \"resourceCollections\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" + "mode": "params" }, - "description": "Update resource with default resource collection. Ensure resource should not associated to any resource collection and resource should not be updated and not older than 15 min. Only single Resource Collection is allowed to update.", + "description": "Update an existing Channel by ID in a given organization.", "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -182732,15 +217718,20 @@ "path": [ "organization", ":orgid", - "resource-collection", - "update-resource" + "channel", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Channel", + "key": "id", + "value": "" } ] } @@ -182760,26 +217751,19 @@ "name": "Unauthorized Operation", "originalRequest": { "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"resourceId\": \"\",\n \"resourceType\": \"\",\n \"resourceCollections\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" + "mode": "params" }, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -182787,14 +217771,20 @@ "path": [ "organization", ":orgid", - "resource-collection", - "update-resource" + "channel", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Channel", + "key": "id", + "value": "" } ] } @@ -182804,7 +217794,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": [ { @@ -182812,29 +217802,22 @@ "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 \"resourceId\": \"\",\n \"resourceType\": \"\",\n \"resourceCollections\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" + "mode": "params" }, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -182842,19 +217825,79 @@ "path": [ "organization", ":orgid", - "resource-collection", - "update-resource" + "channel", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Channel", + "key": "id", + "value": "" } ] } }, - "status": "Bad Request" + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"channelType\": \"CUSTOM_MESSAGING\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"3\ufeff\",\n \"organizationId\": \"87BEEdd5-ddcd-0E63E1d1AB3f07232def\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"logoUrl\": \"\",\n \"logoUrlVersioned\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"webp\",\n \"jpeg\"\n ],\n \"key_1\": [\n \"pdfxml\",\n \"bmp\"\n ]\n }\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "channel", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", + "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 Channel", + "key": "id", + "value": "" + } + ] + } + }, + "status": "OK" }, { "_postman_previewlanguage": "json", @@ -182870,26 +217913,19 @@ "name": "An Unexpected Error Occurred", "originalRequest": { "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"resourceId\": \"\",\n \"resourceType\": \"\",\n \"resourceCollections\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" + "mode": "params" }, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -182897,14 +217933,20 @@ "path": [ "organization", ":orgid", - "resource-collection", - "update-resource" + "channel", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Channel", + "key": "id", + "value": "" } ] } @@ -182925,26 +217967,19 @@ "name": "Operation is forbidden", "originalRequest": { "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"resourceId\": \"\",\n \"resourceType\": \"\",\n \"resourceCollections\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" + "mode": "params" }, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -182952,14 +217987,20 @@ "path": [ "organization", ":orgid", - "resource-collection", - "update-resource" + "channel", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Channel", + "key": "id", + "value": "" } ] } @@ -182967,39 +218008,32 @@ "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"response\": [\n {\n \"id\": \"\",\n \"resourceType\": \"\",\n \"status\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"resourceType\": \"\",\n \"status\": \"\",\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": 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": 412, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Created", + "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 \"resourceId\": \"\",\n \"resourceType\": \"\",\n \"resourceCollections\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" + "mode": "params" }, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "multipart/form-data" }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -183007,24 +218041,30 @@ "path": [ "organization", ":orgid", - "resource-collection", - "update-resource" + "channel", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Channel", + "key": "id", + "value": "" } ] } }, - "status": "Created" + "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": 409, + "code": 404, "cookie": [], "header": [ { @@ -183032,29 +218072,22 @@ "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 \"resourceId\": \"\",\n \"resourceType\": \"\",\n \"resourceCollections\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" + "mode": "params" }, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -183062,24 +218095,30 @@ "path": [ "organization", ":orgid", - "resource-collection", - "update-resource" + "channel", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Channel", + "key": "id", + "value": "" } ] } }, - "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": 429, + "code": 400, "cookie": [], "header": [ { @@ -183087,29 +218126,22 @@ "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 \"resourceId\": \"\",\n \"resourceType\": \"\",\n \"resourceCollections\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" + "mode": "params" }, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -183117,33 +218149,39 @@ "path": [ "organization", ":orgid", - "resource-collection", - "update-resource" + "channel", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Channel", + "key": "id", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "Bad Request" } ] }, { - "name": "Get specific Resource Collection by ID", + "name": "Delete specific Channel by ID", "request": { - "description": "Retrieve an existing Resource Collection by ID in a given organization.", + "description": "Delete an existing Channel by ID in a given organization.", "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -183151,10 +218189,10 @@ "path": [ "organization", ":orgid", - "resource-collection", + "channel", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -183162,7 +218200,7 @@ "value": "" }, { - "description": "Resource ID of the Resource Collection.", + "description": "Resource ID of the Channel", "key": "id", "value": "" } @@ -183173,7 +218211,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": [ { @@ -183181,7 +218219,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -183189,7 +218227,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -183197,28 +218235,30 @@ "path": [ "organization", ":orgid", - "resource-collection", + "channel", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Resource Collection.", - "key": "id" + "description": "Resource ID of the Channel", + "key": "id", + "value": "" } ] } }, - "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": [ { @@ -183226,7 +218266,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": [ { @@ -183234,7 +218274,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -183242,28 +218282,30 @@ "path": [ "organization", ":orgid", - "resource-collection", + "channel", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Resource Collection.", - "key": "id" + "description": "Resource ID of the Channel", + "key": "id", + "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": 412, "cookie": [], "header": [ { @@ -183271,7 +218313,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": [ { @@ -183279,7 +218321,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -183287,28 +218329,30 @@ "path": [ "organization", ":orgid", - "resource-collection", + "channel", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Resource Collection.", - "key": "id" + "description": "Resource ID of the Channel", + "key": "id", + "value": "" } ] } }, - "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": 429, + "code": 403, "cookie": [], "header": [ { @@ -183316,7 +218360,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": [ { @@ -183324,7 +218368,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -183332,28 +218376,30 @@ "path": [ "organization", ":orgid", - "resource-collection", + "channel", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Resource Collection.", - "key": "id" + "description": "Resource ID of the Channel", + "key": "id", + "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": 500, + "code": 401, "cookie": [], "header": [ { @@ -183361,7 +218407,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -183369,7 +218415,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -183377,44 +218423,83 @@ "path": [ "organization", ":orgid", - "resource-collection", + "channel", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Resource Collection.", - "key": "id" + "description": "Resource ID of the Channel", + "key": "id", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", - "body": "{\n \"name\": \"4\u00a02lgM\u2003\u2008t\",\n \"organizationId\": \"4c89048aeF9eB455-FbFC2d9fC96537b6\",\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}", - "code": 200, + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "channel", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", + "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 Channel", + "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": 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}}" @@ -183422,28 +218507,30 @@ "path": [ "organization", ":orgid", - "resource-collection", + "channel", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Resource Collection.", - "key": "id" + "description": "Resource ID of the Channel", + "key": "id", + "value": "" } ] } }, - "status": "OK" + "status": "Not Found" } ] }, { - "name": "Update specific Resource Collection by ID", + "name": "Partially update Channel by ID", "request": { "body": { "mode": "raw", @@ -183453,9 +218540,9 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + "raw": "{\n \"description\": \"\",\n \"logoType\": \"MOMENTUM\",\n \"logoIconName\": \"\"\n}" }, - "description": "Update an existing resource collection by ID in a given organization.", + "description": "Partially update a channel by ID. Only the supplied fields are changed; absent fields retain their current values. Patchable fields: name, description, logoType (MOMENTUM only), logoIconName. logoUrl and logoUrlVersioned cannot be changed by using PATCH; use PUT to update the logo image. channelType cannot be changed after creation. in a given organization.", "header": [ { "key": "Content-Type", @@ -183466,7 +218553,7 @@ "value": "*/*" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -183474,10 +218561,10 @@ "path": [ "organization", ":orgid", - "resource-collection", + "channel", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -183485,7 +218572,7 @@ "value": "" }, { - "description": "Resource ID of the Resource Collection.", + "description": "Resource ID of the Channel", "key": "id", "value": "" } @@ -183496,7 +218583,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": [ { @@ -183504,7 +218591,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": { "body": { "mode": "raw", @@ -183514,7 +218601,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + "raw": "{\n \"description\": \"\",\n \"logoType\": \"MOMENTUM\",\n \"logoIconName\": \"\"\n}" }, "header": [ { @@ -183526,7 +218613,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -183534,28 +218621,30 @@ "path": [ "organization", ":orgid", - "resource-collection", + "channel", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Resource Collection.", - "key": "id" + "description": "Resource ID of the Channel", + "key": "id", + "value": "" } ] } }, - "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": 401, + "code": 429, "cookie": [], "header": [ { @@ -183563,7 +218652,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", @@ -183573,7 +218662,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + "raw": "{\n \"description\": \"\",\n \"logoType\": \"MOMENTUM\",\n \"logoIconName\": \"\"\n}" }, "header": [ { @@ -183585,7 +218674,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -183593,28 +218682,30 @@ "path": [ "organization", ":orgid", - "resource-collection", + "channel", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Resource Collection.", - "key": "id" + "description": "Resource ID of the Channel", + "key": "id", + "value": "" } ] } }, - "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": [ { @@ -183622,7 +218713,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", @@ -183632,7 +218723,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + "raw": "{\n \"description\": \"\",\n \"logoType\": \"MOMENTUM\",\n \"logoIconName\": \"\"\n}" }, "header": [ { @@ -183644,7 +218735,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -183652,28 +218743,30 @@ "path": [ "organization", ":orgid", - "resource-collection", + "channel", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Resource Collection.", - "key": "id" + "description": "Resource ID of the Channel", + "key": "id", + "value": "" } ] } }, - "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": 429, + "code": 401, "cookie": [], "header": [ { @@ -183681,7 +218774,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", @@ -183691,7 +218784,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + "raw": "{\n \"description\": \"\",\n \"logoType\": \"MOMENTUM\",\n \"logoIconName\": \"\"\n}" }, "header": [ { @@ -183703,7 +218796,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -183711,36 +218804,38 @@ "path": [ "organization", ":orgid", - "resource-collection", + "channel", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Resource Collection.", - "key": "id" + "description": "Resource ID of the Channel", + "key": "id", + "value": "" } ] } }, - "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 \"channelType\": \"CUSTOM_MESSAGING\",\n \"logoType\": \"MOMENTUM\",\n \"name\": \"3\ufeff\",\n \"organizationId\": \"87BEEdd5-ddcd-0E63E1d1AB3f07232def\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"logoIconName\": \"\",\n \"logoUrl\": \"\",\n \"logoUrlVersioned\": \"\",\n \"numberOfAsset\": \"\",\n \"messagingPolicy\": {\n \"allowFileAttachments\": \"\",\n \"maxMessageCharacters\": \"\",\n \"maxNumberOfAttachments\": \"\",\n \"maxTotalAttachmentSizeMegabytes\": \"\",\n \"maxSingleAttachmentSizeMegabytes\": \"\",\n \"allowedFileTypes\": {\n \"key_0\": [\n \"webp\",\n \"jpeg\"\n ],\n \"key_1\": [\n \"pdfxml\",\n \"bmp\"\n ]\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", @@ -183750,7 +218845,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + "raw": "{\n \"description\": \"\",\n \"logoType\": \"MOMENTUM\",\n \"logoIconName\": \"\"\n}" }, "header": [ { @@ -183759,10 +218854,10 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -183770,28 +218865,30 @@ "path": [ "organization", ":orgid", - "resource-collection", + "channel", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Resource Collection.", - "key": "id" + "description": "Resource ID of the Channel", + "key": "id", + "value": "" } ] } }, - "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": 500, "cookie": [], "header": [ { @@ -183799,7 +218896,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", @@ -183809,7 +218906,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + "raw": "{\n \"description\": \"\",\n \"logoType\": \"MOMENTUM\",\n \"logoIconName\": \"\"\n}" }, "header": [ { @@ -183821,7 +218918,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -183829,28 +218926,30 @@ "path": [ "organization", ":orgid", - "resource-collection", + "channel", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Resource Collection.", - "key": "id" + "description": "Resource ID of the Channel", + "key": "id", + "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": 500, + "code": 403, "cookie": [], "header": [ { @@ -183858,7 +218957,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -183868,7 +218967,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" + "raw": "{\n \"description\": \"\",\n \"logoType\": \"MOMENTUM\",\n \"logoIconName\": \"\"\n}" }, "header": [ { @@ -183880,66 +218979,7 @@ "value": "application/json" } ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "resource-collection", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Resource Collection.", - "key": "id" - } - ] - } - }, - "status": "Internal Server Error" - }, - { - "_postman_previewlanguage": "text", - "body": "{\n \"name\": \"4\u00a02lgM\u2003\u2008t\",\n \"organizationId\": \"4c89048aeF9eB455-FbFC2d9fC96537b6\",\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}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"Lmppj\u2009Cz\u1680V\\n\",\n \"organizationId\": \"aD768bd6-0C1b5cD3D06B03A5Df055fDE\",\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}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -183947,37 +218987,39 @@ "path": [ "organization", ":orgid", - "resource-collection", + "channel", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "raw": "{{baseUrl}}/organization/:orgid/channel/:id", "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 Resource Collection.", - "key": "id" + "description": "Resource ID of the Channel", + "key": "id", + "value": "" } ] } }, - "status": "OK" + "status": "Forbidden" } ] }, { - "name": "Delete specific Resource Collection by ID", + "name": "List references for a specific Channel", "request": { - "description": "Delete an existing resource collection by ID in a given organization.", + "description": "Retrieve a list of all entities that have reference to an existing Channel by ID in a given organization. Includes Asset and Entry Point entities that reference the channel.", "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -183985,10 +219027,28 @@ "path": [ "organization", ":orgid", - "resource-collection", - ":id" + "channel", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/: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/channel/: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.", @@ -183996,7 +219056,7 @@ "value": "" }, { - "description": "Resource ID of the Resource Collection.", + "description": "ID of this contact center resource.", "key": "id", "value": "" } @@ -184023,7 +219083,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -184031,79 +219091,64 @@ "path": [ "organization", ":orgid", - "resource-collection", - ":id" + "channel", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/: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 Resource Collection.", - "key": "id" - } - ] - } - }, - "status": "Internal Server Error" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 204, - "cookie": [], - "header": [], - "name": "No Content", - "originalRequest": { - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "resource-collection", - ":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" + } ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id", + "raw": "{{baseUrl}}/organization/:orgid/channel/: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" + "key": "orgid", + "value": "" }, { - "description": "Resource ID of the Resource Collection.", - "key": "id" + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "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": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"a8dFD929ea07779ED5bC57C3C2BDA4dB\",\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 },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\"\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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -184111,28 +219156,48 @@ "path": [ "organization", ":orgid", - "resource-collection", - ":id" + "channel", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/: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/channel/: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" + "key": "orgid", + "value": "" }, { - "description": "Resource ID of the Resource Collection.", - "key": "id" + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "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": [ { @@ -184140,7 +219205,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -184148,7 +219213,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -184156,28 +219221,48 @@ "path": [ "organization", ":orgid", - "resource-collection", - ":id" + "channel", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/: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/channel/: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" + "key": "orgid", + "value": "" }, { - "description": "Resource ID of the Resource Collection.", - "key": "id" + "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": 429, "cookie": [], "header": [ { @@ -184185,7 +219270,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": [ { @@ -184193,7 +219278,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -184201,28 +219286,48 @@ "path": [ "organization", ":orgid", - "resource-collection", - ":id" + "channel", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/: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/channel/: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" + "key": "orgid", + "value": "" }, { - "description": "Resource ID of the Resource Collection.", - "key": "id" + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "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": 403, "cookie": [], "header": [ { @@ -184230,7 +219335,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": [ { @@ -184238,7 +219343,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -184246,23 +219351,43 @@ "path": [ "organization", ":orgid", - "resource-collection", - ":id" + "channel", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/: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/channel/: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" + "key": "orgid", + "value": "" }, { - "description": "Resource ID of the Resource Collection.", - "key": "id" + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Precondition Failed" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -184283,7 +219408,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -184291,18 +219416,38 @@ "path": [ "organization", ":orgid", - "resource-collection", - ":id" + "channel", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/: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/channel/: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" + "key": "orgid", + "value": "" }, { - "description": "Resource ID of the Resource Collection.", - "key": "id" + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } @@ -184312,9 +219457,9 @@ ] }, { - "name": "List references for a specific Resource Collection", + "name": "List Channels", "request": { - "description": "Retrieve a list of all entities that have reference to an existing resource collection by ID in a given organization.", + "description": "Retrieve a list of Channels in a given organization. Supports pagination metadata. Set includeLogoUrlVersioned to true to include logoUrlVersioned in the response. 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", @@ -184329,14 +219474,23 @@ "path": [ "organization", ":orgid", - "resource-collection", - ":id", - "incoming-references" + "v2", + "channel" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Filter expression", + "key": "filter", + "value": "" + }, + { + "description": "Supported attributes", + "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": "" }, { @@ -184348,19 +219502,34 @@ "description": "Defines the number of items to be displayed on a page. If the number specified 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": "Sortable properties", + "key": "sort", + "value": "name" + }, + { + "description": "If set to true, the API response includes the asset count.", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "Include logoUrlVersioned in the response.", + "key": "includeLogoUrlVersioned", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/channel?filter=&attributes=&search=&page=0&pageSize=100&sort=name&includeCount=false&singleObjectResponse=false&includeLogoUrlVersioned=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": "" } ] } @@ -184368,7 +219537,7 @@ "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}", + "body": "{\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"data\": [\n {\n \"organizationId\": \"2DFAd8eBfdBE2F24-fFEb-bBd6705AF1eB\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\u2029LU\\t\",\n \"description\": \"\",\n \"channelType\": \"FAX\",\n \"logoType\": \"MOMENTUM\",\n \"logoIconName\": \"\",\n \"logoUrl\": \"\",\n \"logoUrlVersioned\": \"\",\n \"numberOfAsset\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"071b9da3-0E8afCeE-9f2Df33f33648a9A\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"i-\u2006\u20093W\u1680uxc\",\n \"description\": \"\",\n \"channelType\": \"FAX\",\n \"logoType\": \"MOMENTUM\",\n \"logoIconName\": \"\",\n \"logoUrl\": \"\",\n \"logoUrlVersioned\": \"\",\n \"numberOfAsset\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -184393,14 +219562,23 @@ "path": [ "organization", ":orgid", - "resource-collection", - ":id", - "incoming-references" + "v2", + "channel" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Filter expression", + "key": "filter", + "value": "" + }, + { + "description": "Supported attributes", + "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": "" }, { @@ -184412,17 +219590,34 @@ "description": "Defines the number of items to be displayed on a page. If the number specified 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": "Sortable properties", + "key": "sort", + "value": "name" + }, + { + "description": "If set to true, the API response includes the asset count.", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "Include logoUrlVersioned in the response.", + "key": "includeLogoUrlVersioned", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/channel?filter=&attributes=&search=&page=0&pageSize=100&sort=name&includeCount=false&singleObjectResponse=false&includeLogoUrlVersioned=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" + "key": "orgid", + "value": "" } ] } @@ -184456,14 +219651,23 @@ "path": [ "organization", ":orgid", - "resource-collection", - ":id", - "incoming-references" + "v2", + "channel" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Filter expression", + "key": "filter", + "value": "" + }, + { + "description": "Supported attributes", + "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": "" }, { @@ -184475,17 +219679,34 @@ "description": "Defines the number of items to be displayed on a page. If the number specified 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": "Sortable properties", + "key": "sort", + "value": "name" + }, + { + "description": "If set to true, the API response includes the asset count.", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "Include logoUrlVersioned in the response.", + "key": "includeLogoUrlVersioned", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/channel?filter=&attributes=&search=&page=0&pageSize=100&sort=name&includeCount=false&singleObjectResponse=false&includeLogoUrlVersioned=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" + "key": "orgid", + "value": "" } ] } @@ -184495,7 +219716,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": [ { @@ -184503,7 +219724,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -184519,14 +219740,23 @@ "path": [ "organization", ":orgid", - "resource-collection", - ":id", - "incoming-references" + "v2", + "channel" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Filter expression", + "key": "filter", + "value": "" + }, + { + "description": "Supported attributes", + "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": "" }, { @@ -184538,27 +219768,44 @@ "description": "Defines the number of items to be displayed on a page. If the number specified 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": "Sortable properties", + "key": "sort", + "value": "name" + }, + { + "description": "If set to true, the API response includes the asset count.", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "Include logoUrlVersioned in the response.", + "key": "includeLogoUrlVersioned", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/channel?filter=&attributes=&search=&page=0&pageSize=100&sort=name&includeCount=false&singleObjectResponse=false&includeLogoUrlVersioned=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" + "key": "orgid", + "value": "" } ] } }, - "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": [ { @@ -184566,7 +219813,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -184582,14 +219829,23 @@ "path": [ "organization", ":orgid", - "resource-collection", - ":id", - "incoming-references" + "v2", + "channel" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Filter expression", + "key": "filter", + "value": "" + }, + { + "description": "Supported attributes", + "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": "" }, { @@ -184601,22 +219857,39 @@ "description": "Defines the number of items to be displayed on a page. If the number specified 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": "Sortable properties", + "key": "sort", + "value": "name" + }, + { + "description": "If set to true, the API response includes the asset count.", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "Include logoUrlVersioned in the response.", + "key": "includeLogoUrlVersioned", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/channel?filter=&attributes=&search=&page=0&pageSize=100&sort=name&includeCount=false&singleObjectResponse=false&includeLogoUrlVersioned=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" + "key": "orgid", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -184645,14 +219918,23 @@ "path": [ "organization", ":orgid", - "resource-collection", - ":id", - "incoming-references" + "v2", + "channel" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Filter expression", + "key": "filter", + "value": "" + }, + { + "description": "Supported attributes", + "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": "" }, { @@ -184664,96 +219946,738 @@ "description": "Defines the number of items to be displayed on a page. If the number specified 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": "Sortable properties", + "key": "sort", + "value": "name" + }, + { + "description": "If set to true, the API response includes the asset count.", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "Include logoUrlVersioned in the response.", + "key": "includeLogoUrlVersioned", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/channel?filter=&attributes=&search=&page=0&pageSize=100&sort=name&includeCount=false&singleObjectResponse=false&includeLogoUrlVersioned=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" + }, + { + "_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", + "channel" + ], + "query": [ + { + "description": "Filter expression", + "key": "filter", + "value": "" }, { - "description": "ID of this contact center resource.", - "key": "id" + "description": "Supported attributes", + "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": "Sortable properties", + "key": "sort", + "value": "name" + }, + { + "description": "If set to true, the API response includes the asset count.", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "Include logoUrlVersioned in the response.", + "key": "includeLogoUrlVersioned", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/channel?filter=&attributes=&search=&page=0&pageSize=100&sort=name&includeCount=false&singleObjectResponse=false&includeLogoUrlVersioned=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": "Unauthorized" + } + ] + } + ], + "name": "Channel" + }, + { + "item": [ + { + "name": "Get available resource types", + "request": { + "description": "Returns the list of available resource types that can be used for report generation, along with available data dates.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports", + "resource-types" + ], + "raw": "{{baseUrl}}/v1/usage-reports/resource-types" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports", + "resource-types" + ], + "raw": "{{baseUrl}}/v1/usage-reports/resource-types" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "[\n {\n \"resourceType\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"dataStartDate\": \"\",\n \"dataEndDate\": \"\"\n },\n {\n \"resourceType\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"dataStartDate\": \"\",\n \"dataEndDate\": \"\"\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", + "usage-reports", + "resource-types" + ], + "raw": "{{baseUrl}}/v1/usage-reports/resource-types" + } + }, + "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": [ + "v1", + "usage-reports", + "resource-types" + ], + "raw": "{{baseUrl}}/v1/usage-reports/resource-types" + } + }, + "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": [ + "v1", + "usage-reports", + "resource-types" + ], + "raw": "{{baseUrl}}/v1/usage-reports/resource-types" + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports", + "resource-types" + ], + "raw": "{{baseUrl}}/v1/usage-reports/resource-types" + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports", + "resource-types" + ], + "raw": "{{baseUrl}}/v1/usage-reports/resource-types" + } + }, + "status": "Bad Gateway" + }, + { + "_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": [ + "v1", + "usage-reports", + "resource-types" + ], + "raw": "{{baseUrl}}/v1/usage-reports/resource-types" + } + }, + "status": "Unauthorized" + } + ] + }, + { + "name": "Create usage report", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceType\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}" + }, + "description": "Creates a new usage report for the specified organization, resource type,\nand date range. The report is generated asynchronously in the background.\n\nA single **usage report (reportId)** is always created for each request.\nDepending on the requested date range, the report may contain **one or more\nreport files**, each representing a sub-range of the overall time period.\n\nWhen the requested date range spans **more than 30 days**, the overall range\nis **automatically split by natural calendar months**, and **multiple report\nfiles** are generated under the same report.\n\n**Examples:**\n\n- Requested range: `2025-12-23` ~ `2026-03-20`\n - Generated result:\n - Report ID: single report\n - Report files:\n - `2025-12-23` ~ `2025-12-31`\n - `2026-01-01` ~ `2026-01-31`\n - `2026-02-01` ~ `2026-02-28`\n - `2026-03-01` ~ `2026-03-20`\n\n- Requested range: `2025-12-23` ~ `2026-01-21`\n - Generated result:\n - Report ID: single report\n - Report files:\n - `2025-12-23` ~ `2026-01-21`\n\n**Important Notes:**\n- Only one usage report can be processed at a time for the same organization.\n If there is an ongoing report, new report creation requests will be rejected.\n", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports" + ], + "raw": "{{baseUrl}}/v1/usage-reports" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceType\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports" + ], + "raw": "{{baseUrl}}/v1/usage-reports" + } + }, + "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": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceType\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports" + ], + "raw": "{{baseUrl}}/v1/usage-reports" + } + }, + "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": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceType\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports" + ], + "raw": "{{baseUrl}}/v1/usage-reports" + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "json", + "body": "[\n {\n \"reportId\": \"\",\n \"createdTime\": \"\"\n },\n {\n \"reportId\": \"\",\n \"createdTime\": \"\"\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 \"resourceType\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports" + ], + "raw": "{{baseUrl}}/v1/usage-reports" + } + }, + "status": "OK" + }, + { + "_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 \"resourceType\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports" + ], + "raw": "{{baseUrl}}/v1/usage-reports" + } + }, + "status": "Unauthorized" + }, + { + "_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 \"resourceType\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports" + ], + "raw": "{{baseUrl}}/v1/usage-reports" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceType\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports" + ], + "raw": "{{baseUrl}}/v1/usage-reports" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: There is already a running report for this organization", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceType\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports" + ], + "raw": "{{baseUrl}}/v1/usage-reports" + } + }, "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": null, + "code": 503, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"resourceType\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organization", - ":orgid", - "resource-collection", - ":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" - } + "v1", + "usage-reports" ], - "raw": "{{baseUrl}}/organization/:orgid/resource-collection/: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" - } - ] + "raw": "{{baseUrl}}/v1/usage-reports" } }, - "status": "Unauthorized" + "status": "Service Unavailable" } ] }, { - "name": "List Resource Collections", + "name": "List usage reports", "request": { - "description": "Retrieve a list of resource collections in a given organization.", + "description": "Retrieves a list of usage reports for the organization. Supports optional filtering by resource type and creation date range.\n\nEach report has a `reportId` and may contain one or more generated files in `reportFiles[]`. For long date ranges, the service can split results by calendar month to avoid creating a single very large download. For example, a 12-month report can return up to 12 report files, and a 36-month report can return up to 36 report files.\n\nUse `reportId` to retrieve the overall report status, list the generated files, or delete the report. Use each file's `fileId` or `downloadUrl` to download that specific file. The download API does not accept `reportId`.", "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -184762,257 +220686,194 @@ "{{baseUrl}}" ], "path": [ - "organization", - ":orgid", - "v2", - "resource-collection" + "v1", + "usage-reports" ], "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.", - "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", + "description": "Filter by resource type", + "key": "resourceType", "value": "" }, { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Filter reports created after this timestamp (ISO 8601 format)", + "key": "createdAfter", + "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": "Filter reports created before this timestamp (ISO 8601 format)", + "key": "createdBefore", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/resource-collection?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": "" - } - ] + "raw": "{{baseUrl}}/v1/usage-reports?resourceType=&createdAfter=&createdBefore=" } }, "response": [ { "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"orgid\": \"7a3DfC3F-616CEfd184De-949c19bdbF3b\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {}\n },\n \"data\": [\n {\n \"name\": \"pkIDn\u00a0 67j\u2002\",\n \"organizationId\": \"9Cb2c2E8208eF8e5-48AdfA5eA2ccD852\",\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 \"name\": \"q\u3000ul\\u000bm\u2000ie\",\n \"organizationId\": \"5f12ef3Dec0caCacc407-acaF5BCfCE2C\",\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}", - "code": 200, + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "*/*" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organization", - ":orgid", - "v2", - "resource-collection" + "v1", + "usage-reports" ], "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", + "description": "Filter by resource type", + "key": "resourceType", "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 reports created after this timestamp (ISO 8601 format)", + "key": "createdAfter", + "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", + "description": "Filter reports created before this timestamp (ISO 8601 format)", + "key": "createdBefore", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/usage-reports?resourceType=&createdAfter=&createdBefore=" + } + }, + "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": [ + "v1", + "usage-reports" + ], + "query": [ + { + "description": "Filter by resource type", + "key": "resourceType", "value": "" }, { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Filter reports created after this timestamp (ISO 8601 format)", + "key": "createdAfter", + "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": "Filter reports created before this timestamp (ISO 8601 format)", + "key": "createdBefore", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/resource-collection?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" - } - ] + "raw": "{{baseUrl}}/v1/usage-reports?resourceType=&createdAfter=&createdBefore=" } }, - "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: Something went wrong on the server", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organization", - ":orgid", - "v2", - "resource-collection" + "v1", + "usage-reports" ], "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.", - "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", + "description": "Filter by resource type", + "key": "resourceType", "value": "" }, { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Filter reports created after this timestamp (ISO 8601 format)", + "key": "createdAfter", + "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": "Filter reports created before this timestamp (ISO 8601 format)", + "key": "createdBefore", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/resource-collection?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" - } - ] + "raw": "{{baseUrl}}/v1/usage-reports?resourceType=&createdAfter=&createdBefore=" } }, "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": null, + "code": 502, "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", + "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": [ "{{baseUrl}}" ], "path": [ - "organization", - ":orgid", - "v2", - "resource-collection" + "v1", + "usage-reports" ], "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.", - "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", + "description": "Filter by resource type", + "key": "resourceType", "value": "" }, { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Filter reports created after this timestamp (ISO 8601 format)", + "key": "createdAfter", + "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": "Filter reports created before this timestamp (ISO 8601 format)", + "key": "createdBefore", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/resource-collection?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" - } - ] + "raw": "{{baseUrl}}/v1/usage-reports?resourceType=&createdAfter=&createdBefore=" } }, - "status": "Too Many Requests" + "status": "Bad Gateway" }, { "_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 {\n \"reportId\": \"7358eaad8b04072ea49f62d0d7ed55b0\",\n \"resourceType\": \"\",\n \"orgId\": \"\",\n \"status\": \"completed\",\n \"createdTime\": \"\",\n \"completedTime\": \"\",\n \"expiryTime\": \"\",\n \"reportFiles\": [\n {\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"status\": \"queued\",\n \"fileId\": \"3b77c00a26574832498ea126bc4d6109\",\n \"fileName\": \"\",\n \"fileSize\": \"\",\n \"checksum\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"status\": \"completed\",\n \"fileId\": \"5a9d17372f1647ca370d168af9f76b17\",\n \"fileName\": \"\",\n \"fileSize\": \"\",\n \"checksum\": \"\",\n \"downloadUrl\": \"\"\n }\n ]\n },\n {\n \"reportId\": \"8531e383a3103ae7d7a01602e4e0a7fe\",\n \"resourceType\": \"\",\n \"orgId\": \"\",\n \"status\": \"queued\",\n \"createdTime\": \"\",\n \"completedTime\": \"\",\n \"expiryTime\": \"\",\n \"reportFiles\": [\n {\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"status\": \"in progress\",\n \"fileId\": \"5f8996a20a163b004033f3b07032d4d7\",\n \"fileName\": \"\",\n \"fileSize\": \"\",\n \"checksum\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"status\": \"queued\",\n \"fileId\": \"7cb6307c20a37fe23791ed8cac5cd323\",\n \"fileName\": \"\",\n \"fileSize\": \"\",\n \"checksum\": \"\",\n \"downloadUrl\": \"\"\n }\n ]\n }\n]", + "code": 200, "cookie": [], "header": [ { @@ -185020,7 +220881,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { "header": [ { @@ -185034,234 +220895,178 @@ "{{baseUrl}}" ], "path": [ - "organization", - ":orgid", - "v2", - "resource-collection" + "v1", + "usage-reports" ], "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.", - "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", + "description": "Filter by resource type", + "key": "resourceType", "value": "" }, { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Filter reports created after this timestamp (ISO 8601 format)", + "key": "createdAfter", + "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": "Filter reports created before this timestamp (ISO 8601 format)", + "key": "createdBefore", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/resource-collection?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" - } - ] + "raw": "{{baseUrl}}/v1/usage-reports?resourceType=&createdAfter=&createdBefore=" } }, - "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": 404, + "_postman_previewlanguage": "text", + "body": null, + "code": 504, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found or URI is invalid", + "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": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organization", - ":orgid", - "v2", - "resource-collection" + "v1", + "usage-reports" ], "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.", - "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", + "description": "Filter by resource type", + "key": "resourceType", "value": "" }, { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Filter reports created after this timestamp (ISO 8601 format)", + "key": "createdAfter", + "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": "Filter reports created before this timestamp (ISO 8601 format)", + "key": "createdBefore", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/resource-collection?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" - } - ] + "raw": "{{baseUrl}}/v1/usage-reports?resourceType=&createdAfter=&createdBefore=" } }, - "status": "Not Found" + "status": "Gateway Timeout" }, { - "_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": 503, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "organization", - ":orgid", - "v2", - "resource-collection" + "v1", + "usage-reports" ], "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", + "description": "Filter by resource type", + "key": "resourceType", "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 reports created after this timestamp (ISO 8601 format)", + "key": "createdAfter", + "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", + "description": "Filter reports created before this timestamp (ISO 8601 format)", + "key": "createdBefore", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/usage-reports?resourceType=&createdAfter=&createdBefore=" + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports" + ], + "query": [ + { + "description": "Filter by resource type", + "key": "resourceType", "value": "" }, { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Filter reports created after this timestamp (ISO 8601 format)", + "key": "createdAfter", + "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": "Filter reports created before this timestamp (ISO 8601 format)", + "key": "createdBefore", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/resource-collection?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" - } - ] + "raw": "{{baseUrl}}/v1/usage-reports?resourceType=&createdAfter=&createdBefore=" } }, - "status": "Unauthorized" + "status": "Bad Request" } ] - } - ], - "name": "Resource Collection" - }, - { - "description": "Operations for managing contact lists and contacts", - "item": [ + }, { - "name": "Create contact list", + "name": "Get usage report details", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"supportedChannels\": [\n \"Email\",\n \"Voice\"\n ],\n \"activationTimeLagMinutes\": \"\",\n \"activationDateTime\": \"\"\n}" - }, - "description": "Creates and activates a contact list for a campaign. The system can activate a contact list even if there are no contact records within it.", + "description": "Retrieves detailed information for a specific usage report.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "campaigns", - ":campaignId", - "contact-list" + "v1", + "usage-reports", + ":reportId" ], - "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list", + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", "variable": [ { - "description": "Campaign ID to which the contact list belongs.", - "key": "campaignId", + "description": "Usage report ID", + "key": "reportId", "value": "" } ] @@ -185269,615 +221074,226 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": null, + "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Invalid request", + "header": [], + "name": "Internal Server Error: Something went wrong on the server", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"supportedChannels\": [\n \"Email\",\n \"Voice\"\n ],\n \"activationTimeLagMinutes\": \"\",\n \"activationDateTime\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "campaigns", - ":campaignId", - "contact-list" + "v1", + "usage-reports", + ":reportId" ], - "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list", + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", "variable": [ { - "description": "Campaign ID to which the contact list belongs.", - "key": "campaignId" + "description": "Usage report ID", + "key": "reportId", + "value": "" } ] } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"outcome\": \"Success\",\n \"statusCode\": \"\",\n \"contactListId\": \"\"\n}", - "code": 201, + "_postman_previewlanguage": "text", + "body": null, + "code": 502, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Contact list created successfully", + "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 \"supportedChannels\": [\n \"Email\",\n \"Voice\"\n ],\n \"activationTimeLagMinutes\": \"\",\n \"activationDateTime\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "campaigns", - ":campaignId", - "contact-list" + "v1", + "usage-reports", + ":reportId" ], - "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list", + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", "variable": [ { - "description": "Campaign ID to which the contact list belongs.", - "key": "campaignId" + "description": "Usage report ID", + "key": "reportId", + "value": "" } ] } }, - "status": "Created" - } - ] - }, - { - "name": "Create contacts within a contact list", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"contacts\": [\n {\n \"contactAttributes\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"contactAttributes\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}" + "status": "Bad Gateway" }, - "description": "Creates contacts within a contact list (only if that contact list was created using API method). If the contact record is invalid, it will be added as INVALID and reflected in the 'Processed' and 'Invalid' counts. This is an Asynchronous operation. The values within the 'contactAttributes' param should conform to datatypes of the contact attributes as specified in the 'Field mapping' associated with the campaign.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v3", - "campaign-management", - "campaigns", - ":campaignId", - "contact-list", - ":contactListId", - "contacts" - ], - "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/contacts", - "variable": [ - { - "description": "Campaign ID to which the contact list belongs.", - "key": "campaignId", - "value": "" - }, - { - "description": "Contact List ID (as a number string).", - "key": "contactListId", - "value": "5" - } - ] - } - }, - "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"outcome\": \"Accepted\",\n \"statusCode\": \"\",\n \"summary\": \"\"\n}", - "code": 202, + "_postman_previewlanguage": "text", + "body": null, + "code": 400, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Request accepted", + "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 \"contacts\": [\n {\n \"contactAttributes\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"contactAttributes\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "campaigns", - ":campaignId", - "contact-list", - ":contactListId", - "contacts" + "v1", + "usage-reports", + ":reportId" ], - "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/contacts", + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", "variable": [ { - "description": "Campaign ID to which the contact list belongs.", - "key": "campaignId" - }, - { - "description": "Contact List ID (as a number string).", - "key": "contactListId" + "description": "Usage report ID", + "key": "reportId", + "value": "" } ] } }, - "status": "Accepted" + "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": null, + "code": 503, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Invalid request", + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"contacts\": [\n {\n \"contactAttributes\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"contactAttributes\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "campaigns", - ":campaignId", - "contact-list", - ":contactListId", - "contacts" + "v1", + "usage-reports", + ":reportId" ], - "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/contacts", + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", "variable": [ { - "description": "Campaign ID to which the contact list belongs.", - "key": "campaignId" - }, - { - "description": "Contact List ID (as a number string).", - "key": "contactListId" + "description": "Usage report ID", + "key": "reportId", + "value": "" } ] } }, - "status": "Bad Request" - } - ] - }, - { - "name": "Update a contact's status within a contact list", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"contactStatus\": \"CLOSED\"\n}" + "status": "Service Unavailable" }, - "description": "Updates a contact's status within a contact list. After update, system overwrites 'Latest Telephony Outcome' to blank and 'Latest Business Outcome' to 'Closed via API call' if status is CLOSED. This is an Asynchronous operation.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PATCH", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v3", - "campaign-management", - "campaigns", - ":campaignId", - "contact-list", - ":contactListId", - "contacts", - ":contactId" - ], - "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/contacts/:contactId", - "variable": [ - { - "description": "Campaign ID.", - "key": "campaignId", - "value": "" - }, - { - "description": "Contact List ID (as a number string).", - "key": "contactListId", - "value": "5" - }, - { - "description": "Contact Unique ID (Customer Unique ID or Account Unique ID or Contact_Phone)", - "key": "contactId", - "value": "" - } - ] - } - }, - "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Invalid request", + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"contactStatus\": \"CLOSED\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "campaigns", - ":campaignId", - "contact-list", - ":contactListId", - "contacts", - ":contactId" + "v1", + "usage-reports", + ":reportId" ], - "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/contacts/:contactId", + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", "variable": [ { - "description": "Campaign ID.", - "key": "campaignId" - }, - { - "description": "Contact List ID (as a number string).", - "key": "contactListId" - }, - { - "description": "Contact Unique ID (Customer Unique ID or Account Unique ID or Contact_Phone)", - "key": "contactId" + "description": "Usage report ID", + "key": "reportId", + "value": "" } ] } }, - "status": "Bad Request" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"outcome\": \"Success\",\n \"statusCode\": \"\",\n \"summary\": \"\"\n}", - "code": 202, + "_postman_previewlanguage": "text", + "body": null, + "code": 404, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Request queued", + "header": [], + "name": "The URI requested is invalid or the resource requested, such as a report 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 \"contactStatus\": \"CLOSED\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "campaigns", - ":campaignId", - "contact-list", - ":contactListId", - "contacts", - ":contactId" + "v1", + "usage-reports", + ":reportId" ], - "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/contacts/:contactId", + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", "variable": [ { - "description": "Campaign ID.", - "key": "campaignId" - }, - { - "description": "Contact List ID (as a number string).", - "key": "contactListId" - }, - { - "description": "Contact Unique ID (Customer Unique ID or Account Unique ID or Contact_Phone)", - "key": "contactId" + "description": "Usage report ID", + "key": "reportId", + "value": "" } ] } }, - "status": "Accepted" - } - ] - }, - { - "name": "Update contact list status", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"contactListStatus\": \"\"\n}" + "status": "Not Found" }, - "description": "Updates the status of a contact list (e.g., EXPIRED). Note: This value is not case-sensitive.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PATCH", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v3", - "campaign-management", - "campaigns", - ":campaignId", - "contact-list", - ":contactListId", - "status" - ], - "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/status", - "variable": [ - { - "description": "Campaign ID.", - "key": "campaignId", - "value": "" - }, - { - "description": "Contact List ID (as a number string).", - "key": "contactListId", - "value": "5" - } - ] - } - }, - "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"outcome\": \"Success\",\n \"statusCode\": \"\",\n \"contactLists\": [\n {\n \"contactListId\": \"\",\n \"contactListStatus\": \"\",\n \"contactListRecordCount\": \"\",\n \"contactListSource\": \"\",\n \"dateOfCreation\": \"\",\n \"dateOfActivation\": \"\",\n \"dateOfExpiry\": \"\"\n },\n {\n \"contactListId\": \"\",\n \"contactListStatus\": \"\",\n \"contactListRecordCount\": \"\",\n \"contactListSource\": \"\",\n \"dateOfCreation\": \"\",\n \"dateOfActivation\": \"\",\n \"dateOfExpiry\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 504, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Contact list status updated successfully", + "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 \"contactListStatus\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PATCH", + "header": [], + "method": "GET", "url": { "host": [ - "{{baseUrl}}" - ], - "path": [ - "v3", - "campaign-management", - "campaigns", - ":campaignId", - "contact-list", - ":contactListId", - "status" + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/status", + "path": [ + "v1", + "usage-reports", + ":reportId" + ], + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", "variable": [ { - "description": "Campaign ID.", - "key": "campaignId" - }, - { - "description": "Contact List ID (as a number string).", - "key": "contactListId" + "description": "Usage report ID", + "key": "reportId", + "value": "" } ] } }, - "status": "OK" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "json", - "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", - "code": 400, + "body": "{\n \"reportId\": \"4c910f57f7b083739a9751e47bb1f19b\",\n \"resourceType\": \"\",\n \"orgId\": \"\",\n \"status\": \"failed\",\n \"createdTime\": \"\",\n \"completedTime\": \"\",\n \"expiryTime\": \"\",\n \"reportFiles\": [\n {\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"status\": \"completed\",\n \"fileId\": \"6d0bb8e8472a2cc31fa13a0d559fa357\",\n \"fileName\": \"\",\n \"fileSize\": \"\",\n \"checksum\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"status\": \"in progress\",\n \"fileId\": \"6f6f4eb46ffe10e3f38f2c31f24acc36\",\n \"fileName\": \"\",\n \"fileSize\": \"\",\n \"checksum\": \"\",\n \"downloadUrl\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { @@ -185885,98 +221301,58 @@ "value": "application/json" } ], - "name": "Invalid request", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"contactListStatus\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "campaigns", - ":campaignId", - "contact-list", - ":contactListId", - "status" + "v1", + "usage-reports", + ":reportId" ], - "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/status", + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", "variable": [ { - "description": "Campaign ID.", - "key": "campaignId" - }, - { - "description": "Contact List ID (as a number string).", - "key": "contactListId" + "description": "Usage report ID", + "key": "reportId", + "value": "" } ] } }, - "status": "Bad Request" + "status": "OK" } ] }, { - "name": "Get Contact Lists within a Campaign", + "name": "Delete usage report", "request": { - "description": "Retrieves all contact lists within a campaign, with optional filters for status and source.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "description": "Deletes the specified usage report and its associated file. This operation cannot be undone.", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "campaigns", - ":campaignId", - "contact-lists" - ], - "query": [ - { - "description": "Contact List Status filter (Active, Expired, UploadFailed, etc.)", - "key": "status", - "value": "Expired" - }, - { - "description": "Contact List Source filter (API, SFTP, ManualFile, GlobalUpload, GlobalSFTP)", - "key": "source", - "value": "GlobalSFTP" - } + "v1", + "usage-reports", + ":reportId" ], - "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-lists?status=Expired&source=GlobalSFTP", + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", "variable": [ { - "description": "Campaign ID.", - "key": "campaignId", + "description": "Usage report ID", + "key": "reportId", "value": "" } ] @@ -185984,194 +221360,97 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"outcome\": \"Failure\",\n \"statusCode\": \"\",\n \"contactLists\": [\n {\n \"contactListId\": \"\",\n \"contactListStatus\": \"\",\n \"contactListRecordProcessed\": \"\",\n \"contactListSource\": \"\",\n \"dateOfCreation\": \"\",\n \"dateOfActivation\": \"\",\n \"dateOfExpiry\": \"\"\n },\n {\n \"contactListId\": \"\",\n \"contactListStatus\": \"\",\n \"contactListRecordProcessed\": \"\",\n \"contactListSource\": \"\",\n \"dateOfCreation\": \"\",\n \"dateOfActivation\": \"\",\n \"dateOfExpiry\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 503, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Contact lists retrieved successfully", + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "campaigns", - ":campaignId", - "contact-lists" - ], - "query": [ - { - "description": "Contact List Status filter (Active, Expired, UploadFailed, etc.)", - "key": "status", - "value": "Expired" - }, - { - "description": "Contact List Source filter (API, SFTP, ManualFile, GlobalUpload, GlobalSFTP)", - "key": "source", - "value": "GlobalSFTP" - } + "v1", + "usage-reports", + ":reportId" ], - "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-lists?status=Expired&source=GlobalSFTP", + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", "variable": [ { - "description": "Campaign ID.", - "key": "campaignId" + "description": "Usage report ID", + "key": "reportId", + "value": "" } ] } }, - "status": "OK" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": null, + "code": 502, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Invalid request", + "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" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v3", - "campaign-management", - "campaigns", - ":campaignId", - "contact-lists" - ], - "query": [ - { - "description": "Contact List Status filter (Active, Expired, UploadFailed, etc.)", - "key": "status", - "value": "Expired" - }, - { - "description": "Contact List Source filter (API, SFTP, ManualFile, GlobalUpload, GlobalSFTP)", - "key": "source", - "value": "GlobalSFTP" - } + "v1", + "usage-reports", + ":reportId" ], - "raw": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-lists?status=Expired&source=GlobalSFTP", + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", "variable": [ { - "description": "Campaign ID.", - "key": "campaignId" + "description": "Usage report ID", + "key": "reportId", + "value": "" } ] } }, - "status": "Bad Request" - } - ] - } - ], - "name": "Contact List Management" - }, - { - "item": [ - { - "name": "List summaries", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"orgId\": \"\",\n \"interactionId\": \"\",\n \"searchType\": \"AGENT\"\n}" + "status": "Bad Gateway" }, - "description": "Lists summaries based on the requested search type.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "summary", - "list" - ], - "raw": "{{baseUrl}}/summary/list" - } - }, - "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 500, "cookie": [], "header": [], - "name": "Unauthorized Operation", + "name": "Internal Server Error: Something went wrong on the server", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"orgId\": \"\",\n \"interactionId\": \"\",\n \"searchType\": \"AGENT\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "summary", - "list" + "v1", + "usage-reports", + ":reportId" ], - "raw": "{{baseUrl}}/summary/list" + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", + "variable": [ + { + "description": "Usage report ID", + "key": "reportId", + "value": "" + } + ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -186179,34 +221458,27 @@ "code": 400, "cookie": [], "header": [], - "name": "Validation Error", + "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 \"orgId\": \"\",\n \"interactionId\": \"\",\n \"searchType\": \"AGENT\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "summary", - "list" + "v1", + "usage-reports", + ":reportId" ], - "raw": "{{baseUrl}}/summary/list" + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", + "variable": [ + { + "description": "Usage report ID", + "key": "reportId", + "value": "" + } + ] } }, "status": "Bad Request" @@ -186214,450 +221486,470 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 504, "cookie": [], "header": [], - "name": "Forbidden Operation", + "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 \"orgId\": \"\",\n \"interactionId\": \"\",\n \"searchType\": \"AGENT\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "summary", - "list" + "v1", + "usage-reports", + ":reportId" ], - "raw": "{{baseUrl}}/summary/list" - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"orgId\": \"\",\n \"agentCiUserId\": \"\",\n \"interactionId\": \"\",\n \"queueId\": \"\",\n \"searchType\": \"AGENT\",\n \"summaries\": {\n \"key_0\": {\n \"key_0\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n },\n \"key_1\": {\n \"key_0\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"key_1\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n \"key_2\": {\n \"key_0\": {\n \"key_0\": \"\"\n }\n }\n }\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Successful operation", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", + "variable": [ + { + "description": "Usage report ID", + "key": "reportId", + "value": "" } - }, - "raw": "{\n \"orgId\": \"\",\n \"interactionId\": \"\",\n \"searchType\": \"AGENT\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "summary", - "list" - ], - "raw": "{{baseUrl}}/summary/list" + ] } }, - "status": "OK" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 204, "cookie": [], "header": [], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"orgId\": \"\",\n \"interactionId\": \"\",\n \"searchType\": \"AGENT\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "summary", - "list" + "v1", + "usage-reports", + ":reportId" ], - "raw": "{{baseUrl}}/summary/list" + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", + "variable": [ + { + "description": "Usage report ID", + "key": "reportId", + "value": "" + } + ] } }, - "status": "Internal Server Error" + "status": "No Content" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 401, "cookie": [], "header": [], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"orgId\": \"\",\n \"interactionId\": \"\",\n \"searchType\": \"AGENT\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "summary", - "list" + "v1", + "usage-reports", + ":reportId" ], - "raw": "{{baseUrl}}/summary/list" + "raw": "{{baseUrl}}/v1/usage-reports/:reportId", + "variable": [ + { + "description": "Usage report ID", + "key": "reportId", + "value": "" + } + ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" } ] }, { - "name": "List summaries", + "name": "Download usage report file", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"orgId\": \"\",\n \"agentCiUserId\": \"\",\n \"searchType\": \"INTERACTION\"\n}" - }, - "description": "Lists summaries based on the requested search type.", + "description": "Downloads one completed report file as a binary stream.\n\nUse the `fileId` returned in the report's `reportFiles` array. A `reportId` identifies the overall report and cannot be used with this endpoint. Usage Reports can cover up to 36 months of raw data, so large date ranges may be split into one file per calendar month. This keeps individual compressed files more manageable and avoids requiring customers to download a single very large file. If a report contains multiple files, call this endpoint once for each `fileId`.\n\nPassing a `reportId` to this endpoint returns `404` because the path parameter expects a file-level identifier.\n\nThe Developer Portal may not handle binary downloads reliably. Use Postman, curl, or a programmatic API client to download the file.\n\n**Note:** Both file and download URLs expire 7 days after report completion.\n", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "application/octet-stream" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "generated-summaries", - "search" + "v1", + "usage-reports", + ":fileId", + "download" ], - "raw": "{{baseUrl}}/generated-summaries/search" + "raw": "{{baseUrl}}/v1/usage-reports/:fileId/download", + "variable": [ + { + "description": "ID of the specific report file to download. Use fileId, not reportId.", + "key": "fileId", + "value": "" + } + ] } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 404, "cookie": [], "header": [], - "name": "Unauthorized Operation", + "name": "The URI requested is invalid or the resource requested, such as a report 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 \"orgId\": \"\",\n \"agentCiUserId\": \"\",\n \"searchType\": \"INTERACTION\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "generated-summaries", - "search" + "v1", + "usage-reports", + ":fileId", + "download" ], - "raw": "{{baseUrl}}/generated-summaries/search" + "raw": "{{baseUrl}}/v1/usage-reports/:fileId/download", + "variable": [ + { + "description": "ID of the specific report file to download. Use fileId, not reportId.", + "key": "fileId", + "value": "" + } + ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 429, "cookie": [], "header": [], - "name": "An Unexpected Error Occurred", + "name": "Too Many Requests: Too many download times", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports", + ":fileId", + "download" + ], + "raw": "{{baseUrl}}/v1/usage-reports/:fileId/download", + "variable": [ + { + "description": "ID of the specific report file to download. Use fileId, not reportId.", + "key": "fileId", + "value": "" } - }, - "raw": "{\n \"orgId\": \"\",\n \"agentCiUserId\": \"\",\n \"searchType\": \"INTERACTION\"\n}" - }, + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": "", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/octet-stream" + } + ], + "name": "Binary stream containing the generated CSV report file", + "originalRequest": { "header": [ { - "key": "Content-Type", - "value": "application/json" + "key": "Accept", + "value": "application/octet-stream" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "generated-summaries", - "search" + "v1", + "usage-reports", + ":fileId", + "download" ], - "raw": "{{baseUrl}}/generated-summaries/search" + "raw": "{{baseUrl}}/v1/usage-reports/:fileId/download", + "variable": [ + { + "description": "ID of the specific report file to download. Use fileId, not reportId.", + "key": "fileId", + "value": "" + } + ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 403, "cookie": [], "header": [], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited.", + "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 \"orgId\": \"\",\n \"agentCiUserId\": \"\",\n \"searchType\": \"INTERACTION\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "generated-summaries", - "search" + "v1", + "usage-reports", + ":fileId", + "download" ], - "raw": "{{baseUrl}}/generated-summaries/search" + "raw": "{{baseUrl}}/v1/usage-reports/:fileId/download", + "variable": [ + { + "description": "ID of the specific report file to download. Use fileId, not reportId.", + "key": "fileId", + "value": "" + } + ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 500, "cookie": [], "header": [], - "name": "Forbidden Operation", + "name": "Internal Server Error: Something went wrong on the server", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"orgId\": \"\",\n \"agentCiUserId\": \"\",\n \"searchType\": \"INTERACTION\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "generated-summaries", - "search" + "v1", + "usage-reports", + ":fileId", + "download" ], - "raw": "{{baseUrl}}/generated-summaries/search" + "raw": "{{baseUrl}}/v1/usage-reports/:fileId/download", + "variable": [ + { + "description": "ID of the specific report file to download. Use fileId, not reportId.", + "key": "fileId", + "value": "" + } + ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"orgId\": \"\",\n \"agentCiUserId\": \"\",\n \"interactionId\": \"\",\n \"queueId\": \"\",\n \"searchType\": \"INTERACTION\",\n \"summaries\": {\n \"POST_CALL\": {\n \"key_0\": {\n \"initialContactReason\": \"\",\n \"additionalContext\": \"\",\n \"additionalContactReasons\": \"\",\n \"keyActionsTaken\": \"\",\n \"nextSteps\": \"\",\n \"chosenWrapUpCode\": \"\",\n \"proposedWrapUpCodes\": [\n {\n \"name\": \"\"\n },\n {\n \"name\": \"\"\n }\n ]\n }\n },\n \"MID_CALL\": {\n \"key_0\": {\n \"reasonForTransferOrConsult\": \"\",\n \"additionalContext\": \"\",\n \"keyActionsTaken\": \"\"\n },\n \"key_1\": {\n \"reasonForTransferOrConsult\": \"\",\n \"additionalContext\": \"\",\n \"keyActionsTaken\": \"\"\n }\n }\n }\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 400, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" + "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": [ + "v1", + "usage-reports", + ":fileId", + "download" + ], + "raw": "{{baseUrl}}/v1/usage-reports/:fileId/download", + "variable": [ + { + "description": "ID of the specific report file to download. Use fileId, not reportId.", + "key": "fileId", + "value": "" + } + ] } - ], - "name": "Successful operation", + }, + "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" + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports", + ":fileId", + "download" + ], + "raw": "{{baseUrl}}/v1/usage-reports/:fileId/download", + "variable": [ + { + "description": "ID of the specific report file to download. Use fileId, not reportId.", + "key": "fileId", + "value": "" } - }, - "raw": "{\n \"orgId\": \"\",\n \"agentCiUserId\": \"\",\n \"searchType\": \"INTERACTION\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + ] + } + }, + "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": { + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "generated-summaries", - "search" + "v1", + "usage-reports", + ":fileId", + "download" ], - "raw": "{{baseUrl}}/generated-summaries/search" + "raw": "{{baseUrl}}/v1/usage-reports/:fileId/download", + "variable": [ + { + "description": "ID of the specific report file to download. Use fileId, not reportId.", + "key": "fileId", + "value": "" + } + ] } }, - "status": "OK" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 401, "cookie": [], "header": [], - "name": "Validation Error", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "usage-reports", + ":fileId", + "download" + ], + "raw": "{{baseUrl}}/v1/usage-reports/:fileId/download", + "variable": [ + { + "description": "ID of the specific report file to download. Use fileId, not reportId.", + "key": "fileId", + "value": "" } - }, - "raw": "{\n \"orgId\": \"\",\n \"agentCiUserId\": \"\",\n \"searchType\": \"INTERACTION\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + ] + } + }, + "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": [ - "generated-summaries", - "search" + "v1", + "usage-reports", + ":fileId", + "download" ], - "raw": "{{baseUrl}}/generated-summaries/search" + "raw": "{{baseUrl}}/v1/usage-reports/:fileId/download", + "variable": [ + { + "description": "ID of the specific report file to download. Use fileId, not reportId.", + "key": "fileId", + "value": "" + } + ] } }, - "status": "Bad Request" + "status": "Service Unavailable" } ] } ], - "name": "Agent Summaries" + "name": "Usage Reports" }, { - "description": "Operations for sending AI Assistant custom events for Webex Contact Center.", + "description": "Operations for updating the data associated with a task from external systems.", "item": [ { - "name": "Get suggestions", + "name": "Update Task Global Variables", "request": { "body": { "mode": "raw", @@ -186667,34 +221959,55 @@ "language": "json" } }, - "raw": "{\n \"agentId\": \"\",\n \"orgId\": \"\",\n \"eventType\": \"CUSTOM_EVENT\",\n \"eventName\": \"GET_SUGGESTIONS\",\n \"eventDetails\": {\n \"data\": {\n \"interactionId\": \"\",\n \"actionTimeStamp\": \"\",\n \"trackingId\": \"\",\n \"languageCode\": \"\",\n \"aiAssistantSkillId\": \"\",\n \"source\": \"\"\n }\n }\n}" + "raw": "{\n \"orgId\": \"0E6A4797-fdaE-2FeB-8df4-649dF31D19aE\",\n \"updateType\": \"contact\",\n \"data\": [\n {\n \"id\": \"DD7AbFd0-Ea4b-2E41-BC69-C9E4EdB9e9f4\",\n \"startTimestamp\": \"8712-01-58T72:63:03.463Z\",\n \"endTimestamp\": \"1338-41-38T48:20:76.830Z\",\n \"globalVariables\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}" }, - "description": "API for getting suggestions based on transcripts. \n\nNotes:\n- Requires machine account token with scope `cjp:config_read` for WxCC\n- Requires machine account token with scope `cjp-hybrid-conn:read` for WxCCE/CCE.\n- `aiAssistantSkillId` / `source` is required for WxCCE/CCE.", + "description": "Updates numeric global variable values associated with a completed Webex Contact Center task. The request must identify the organization and task along with its start and end timestamps. The task should have ended within two days prior to the time of making the request.", "header": [ + { + "description": "Organization identifier used for partner or delegated access.", + "key": "X-ORGANIZATION-ID", + "value": "Bd769d9E-4e6B-3EfA-BE6f-7f0e6Be3984C" + }, + { + "description": "Optional identifier used for request traceability, debugging, and error reporting.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "event" + "v1", + "data", + "updateExternal" ], - "raw": "{{baseUrl}}/event" + "raw": "{{baseUrl}}/v1/data/updateExternal" } }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 429, + "_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": "Too many requests have been sent in a given amount of time and the request has been rate limited.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request. The request is missing required data or contains invalid organization, task, timestamp, update type, or global-variable information.", "originalRequest": { "body": { "mode": "raw", @@ -186704,34 +222017,113 @@ "language": "json" } }, - "raw": "{\n \"agentId\": \"\",\n \"orgId\": \"\",\n \"eventType\": \"CUSTOM_EVENT\",\n \"eventName\": \"GET_SUGGESTIONS\",\n \"eventDetails\": {\n \"data\": {\n \"interactionId\": \"\",\n \"actionTimeStamp\": \"\",\n \"trackingId\": \"\",\n \"languageCode\": \"\",\n \"aiAssistantSkillId\": \"\",\n \"source\": \"\"\n }\n }\n}" + "raw": "{\n \"orgId\": \"0E6A4797-fdaE-2FeB-8df4-649dF31D19aE\",\n \"updateType\": \"contact\",\n \"data\": [\n {\n \"id\": \"DD7AbFd0-Ea4b-2E41-BC69-C9E4EdB9e9f4\",\n \"startTimestamp\": \"8712-01-58T72:63:03.463Z\",\n \"endTimestamp\": \"1338-41-38T48:20:76.830Z\",\n \"globalVariables\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}" }, "header": [ + { + "description": "Organization identifier used for partner or delegated access.", + "key": "X-ORGANIZATION-ID", + "value": "Bd769d9E-4e6B-3EfA-BE6f-7f0e6Be3984C" + }, + { + "description": "Optional identifier used for request traceability, debugging, and error reporting.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "event" + "v1", + "data", + "updateExternal" ], - "raw": "{{baseUrl}}/event" + "raw": "{{baseUrl}}/v1/data/updateExternal" } }, - "status": "Too Many Requests" + "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": 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 \"orgId\": \"0E6A4797-fdaE-2FeB-8df4-649dF31D19aE\",\n \"updateType\": \"contact\",\n \"data\": [\n {\n \"id\": \"DD7AbFd0-Ea4b-2E41-BC69-C9E4EdB9e9f4\",\n \"startTimestamp\": \"8712-01-58T72:63:03.463Z\",\n \"endTimestamp\": \"1338-41-38T48:20:76.830Z\",\n \"globalVariables\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}" + }, + "header": [ + { + "description": "Organization identifier used for partner or delegated access.", + "key": "X-ORGANIZATION-ID", + "value": "Bd769d9E-4e6B-3EfA-BE6f-7f0e6Be3984C" + }, + { + "description": "Optional identifier used for request traceability, debugging, and error reporting.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "data", + "updateExternal" + ], + "raw": "{{baseUrl}}/v1/data/updateExternal" + } + }, + "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": [], - "name": "Unauthorized Operation", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized. Authentication credentials are missing or invalid.", "originalRequest": { "body": { "mode": "raw", @@ -186741,34 +222133,55 @@ "language": "json" } }, - "raw": "{\n \"agentId\": \"\",\n \"orgId\": \"\",\n \"eventType\": \"CUSTOM_EVENT\",\n \"eventName\": \"GET_SUGGESTIONS\",\n \"eventDetails\": {\n \"data\": {\n \"interactionId\": \"\",\n \"actionTimeStamp\": \"\",\n \"trackingId\": \"\",\n \"languageCode\": \"\",\n \"aiAssistantSkillId\": \"\",\n \"source\": \"\"\n }\n }\n}" + "raw": "{\n \"orgId\": \"0E6A4797-fdaE-2FeB-8df4-649dF31D19aE\",\n \"updateType\": \"contact\",\n \"data\": [\n {\n \"id\": \"DD7AbFd0-Ea4b-2E41-BC69-C9E4EdB9e9f4\",\n \"startTimestamp\": \"8712-01-58T72:63:03.463Z\",\n \"endTimestamp\": \"1338-41-38T48:20:76.830Z\",\n \"globalVariables\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}" }, "header": [ + { + "description": "Organization identifier used for partner or delegated access.", + "key": "X-ORGANIZATION-ID", + "value": "Bd769d9E-4e6B-3EfA-BE6f-7f0e6Be3984C" + }, + { + "description": "Optional identifier used for request traceability, debugging, and error reporting.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "event" + "v1", + "data", + "updateExternal" ], - "raw": "{{baseUrl}}/event" + "raw": "{{baseUrl}}/v1/data/updateExternal" } }, "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 400, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"response\": {\n \"key\": \"202\",\n \"message\": [\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 202, "cookie": [], - "header": [], - "name": "Validation Error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Accepted. The request passed configuration-level validation and was accepted for processing. Additional interaction-level validation may occur after acceptance.", "originalRequest": { "body": { "mode": "raw", @@ -186778,34 +222191,55 @@ "language": "json" } }, - "raw": "{\n \"agentId\": \"\",\n \"orgId\": \"\",\n \"eventType\": \"CUSTOM_EVENT\",\n \"eventName\": \"GET_SUGGESTIONS\",\n \"eventDetails\": {\n \"data\": {\n \"interactionId\": \"\",\n \"actionTimeStamp\": \"\",\n \"trackingId\": \"\",\n \"languageCode\": \"\",\n \"aiAssistantSkillId\": \"\",\n \"source\": \"\"\n }\n }\n}" + "raw": "{\n \"orgId\": \"0E6A4797-fdaE-2FeB-8df4-649dF31D19aE\",\n \"updateType\": \"contact\",\n \"data\": [\n {\n \"id\": \"DD7AbFd0-Ea4b-2E41-BC69-C9E4EdB9e9f4\",\n \"startTimestamp\": \"8712-01-58T72:63:03.463Z\",\n \"endTimestamp\": \"1338-41-38T48:20:76.830Z\",\n \"globalVariables\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}" }, "header": [ + { + "description": "Organization identifier used for partner or delegated access.", + "key": "X-ORGANIZATION-ID", + "value": "Bd769d9E-4e6B-3EfA-BE6f-7f0e6Be3984C" + }, + { + "description": "Optional identifier used for request traceability, debugging, and error reporting.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "event" + "v1", + "data", + "updateExternal" ], - "raw": "{{baseUrl}}/event" + "raw": "{{baseUrl}}/v1/data/updateExternal" } }, - "status": "Bad Request" + "status": "Accepted" }, { - "_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": 423, "cookie": [], - "header": [], - "name": "Forbidden Operation", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Locked. The API is disabled by a feature flag or service kill switch.", "originalRequest": { "body": { "mode": "raw", @@ -186815,34 +222249,55 @@ "language": "json" } }, - "raw": "{\n \"agentId\": \"\",\n \"orgId\": \"\",\n \"eventType\": \"CUSTOM_EVENT\",\n \"eventName\": \"GET_SUGGESTIONS\",\n \"eventDetails\": {\n \"data\": {\n \"interactionId\": \"\",\n \"actionTimeStamp\": \"\",\n \"trackingId\": \"\",\n \"languageCode\": \"\",\n \"aiAssistantSkillId\": \"\",\n \"source\": \"\"\n }\n }\n}" + "raw": "{\n \"orgId\": \"0E6A4797-fdaE-2FeB-8df4-649dF31D19aE\",\n \"updateType\": \"contact\",\n \"data\": [\n {\n \"id\": \"DD7AbFd0-Ea4b-2E41-BC69-C9E4EdB9e9f4\",\n \"startTimestamp\": \"8712-01-58T72:63:03.463Z\",\n \"endTimestamp\": \"1338-41-38T48:20:76.830Z\",\n \"globalVariables\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}" }, "header": [ + { + "description": "Organization identifier used for partner or delegated access.", + "key": "X-ORGANIZATION-ID", + "value": "Bd769d9E-4e6B-3EfA-BE6f-7f0e6Be3984C" + }, + { + "description": "Optional identifier used for request traceability, debugging, and error reporting.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "event" + "v1", + "data", + "updateExternal" ], - "raw": "{{baseUrl}}/event" + "raw": "{{baseUrl}}/v1/data/updateExternal" } }, - "status": "Forbidden" + "status": "Locked (WebDAV) (RFC 4918)" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "_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": "An Unexpected Error Occurred", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Forbidden. The caller does not have the required scopes or roles.", "originalRequest": { "body": { "mode": "raw", @@ -186852,34 +222307,55 @@ "language": "json" } }, - "raw": "{\n \"agentId\": \"\",\n \"orgId\": \"\",\n \"eventType\": \"CUSTOM_EVENT\",\n \"eventName\": \"GET_SUGGESTIONS\",\n \"eventDetails\": {\n \"data\": {\n \"interactionId\": \"\",\n \"actionTimeStamp\": \"\",\n \"trackingId\": \"\",\n \"languageCode\": \"\",\n \"aiAssistantSkillId\": \"\",\n \"source\": \"\"\n }\n }\n}" + "raw": "{\n \"orgId\": \"0E6A4797-fdaE-2FeB-8df4-649dF31D19aE\",\n \"updateType\": \"contact\",\n \"data\": [\n {\n \"id\": \"DD7AbFd0-Ea4b-2E41-BC69-C9E4EdB9e9f4\",\n \"startTimestamp\": \"8712-01-58T72:63:03.463Z\",\n \"endTimestamp\": \"1338-41-38T48:20:76.830Z\",\n \"globalVariables\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}" }, "header": [ + { + "description": "Organization identifier used for partner or delegated access.", + "key": "X-ORGANIZATION-ID", + "value": "Bd769d9E-4e6B-3EfA-BE6f-7f0e6Be3984C" + }, + { + "description": "Optional identifier used for request traceability, debugging, and error reporting.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "event" + "v1", + "data", + "updateExternal" ], - "raw": "{{baseUrl}}/event" + "raw": "{{baseUrl}}/v1/data/updateExternal" } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { - "_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": 429, "cookie": [], - "header": [], - "name": "Accepted", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too Many Requests. The organization has exceeded the rate limit of five requests per second.", "originalRequest": { "body": { "mode": "raw", @@ -186889,31 +222365,47 @@ "language": "json" } }, - "raw": "{\n \"agentId\": \"\",\n \"orgId\": \"\",\n \"eventType\": \"CUSTOM_EVENT\",\n \"eventName\": \"GET_SUGGESTIONS\",\n \"eventDetails\": {\n \"data\": {\n \"interactionId\": \"\",\n \"actionTimeStamp\": \"\",\n \"trackingId\": \"\",\n \"languageCode\": \"\",\n \"aiAssistantSkillId\": \"\",\n \"source\": \"\"\n }\n }\n}" + "raw": "{\n \"orgId\": \"0E6A4797-fdaE-2FeB-8df4-649dF31D19aE\",\n \"updateType\": \"contact\",\n \"data\": [\n {\n \"id\": \"DD7AbFd0-Ea4b-2E41-BC69-C9E4EdB9e9f4\",\n \"startTimestamp\": \"8712-01-58T72:63:03.463Z\",\n \"endTimestamp\": \"1338-41-38T48:20:76.830Z\",\n \"globalVariables\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}" }, "header": [ + { + "description": "Organization identifier used for partner or delegated access.", + "key": "X-ORGANIZATION-ID", + "value": "Bd769d9E-4e6B-3EfA-BE6f-7f0e6Be3984C" + }, + { + "description": "Optional identifier used for request traceability, debugging, and error reporting.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "event" + "v1", + "data", + "updateExternal" ], - "raw": "{{baseUrl}}/event" + "raw": "{{baseUrl}}/v1/data/updateExternal" } }, - "status": "OK" + "status": "Too Many Requests" } ] } ], - "name": "AI Assistant" + "name": "External Data Updates" } ], "variable": [ diff --git a/codegen/postman/Webex Device.postman_collection.json b/codegen/postman/Webex Device.postman_collection.json index dc0fceb..f33402f 100644 --- a/codegen/postman/Webex Device.postman_collection.json +++ b/codegen/postman/Webex Device.postman_collection.json @@ -24463,7 +24463,7 @@ { "name": "Get Device Layout by Device ID", "request": { - "description": "Get layout information of a device by device ID in an organization.\n\nDevice layout customizes a user\u2019s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user\u2019s monitoring list.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", + "description": "Get layout information of a device by device ID in an organization.\n\nDevice layout customizes a user\u2019s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user\u2019s monitoring list.\n\n**Note:** When `layoutMode` is DEFAULT, the response includes only `layoutMode` and `userReorderEnabled`. The `lineKeys` field is omitted as the device uses system-assigned default line-key assignments. When `layoutMode` is CUSTOM, the response includes the `lineKeys` array with the custom line-key configuration.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ { "key": "Accept", @@ -24541,7 +24541,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}", + "body": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -25147,9 +25147,9 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, - "description": "Modify the layout of a device by device ID in an organization.\n\nDevice layout customizes a user\u2019s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user\u2019s monitoring list.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", + "description": "Modify the layout of a device by device ID in an organization.\n\nDevice layout customizes a user\u2019s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user\u2019s monitoring list.\n\n**Note:** When setting `layoutMode` to DEFAULT, do not include the `lineKeys` field in the request body. The device will use system-assigned default line-key assignments. When setting `layoutMode` to CUSTOM, you must include the `lineKeys` array to specify the custom line-key configuration.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -25202,7 +25202,7 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, "header": [ { @@ -25256,7 +25256,7 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, "header": [ { @@ -25310,7 +25310,7 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, "header": [ { @@ -25364,7 +25364,7 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, "header": [ { @@ -25418,7 +25418,7 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, "header": [ { @@ -25472,7 +25472,7 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, "header": [ { @@ -25526,7 +25526,7 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, "header": [ { @@ -25580,7 +25580,7 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, "header": [ { @@ -25634,7 +25634,7 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, "header": [ { @@ -25688,7 +25688,7 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, "header": [ { @@ -25742,7 +25742,7 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, "header": [ { @@ -25796,7 +25796,7 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, "header": [ { @@ -25850,7 +25850,7 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, "header": [ { @@ -25904,7 +25904,7 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, "header": [ { @@ -25958,7 +25958,7 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, "header": [ { @@ -26012,7 +26012,7 @@ "language": "json" } }, - "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"userReorderEnabled\": \"\",\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" + "raw": "{\n \"layoutMode\": \"DEFAULT\",\n \"userReorderEnabled\": \"\",\n \"lineKeys\": [\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"SPEED_DIAL\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n },\n {\n \"lineKeyIndex\": \"\",\n \"lineKeyType\": \"MODE_MANAGEMENT\",\n \"sharedLineIndex\": \"\",\n \"lineKeyLabel\": \"\",\n \"lineKeyValue\": \"\"\n }\n ],\n \"kemModuleType\": \"KEM_18_KEYS\",\n \"kemKeys\": [\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"SHARED_LINE\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n },\n {\n \"kemModuleIndex\": \"\",\n \"kemKeyIndex\": \"\",\n \"kemKeyType\": \"CLOSED\",\n \"sharedLineIndex\": \"\",\n \"kemKeyLabel\": \"\",\n \"kemKeyValue\": \"\"\n }\n ]\n}" }, "header": [ { @@ -57706,7 +57706,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"orgId\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"floorId\": \"\",\n \"displayName\": \"\",\n \"capacity\": \"\",\n \"type\": \"meetingRoom\",\n \"sipAddress\": \"\",\n \"created\": \"\",\n \"calling\": {\n \"type\": \"thirdPartySipCalling\",\n \"hybridCalling\": {\n \"emailAddress\": \"\"\n },\n \"webexCalling\": {\n \"licenses\": [\n \"\",\n \"\"\n ]\n }\n },\n \"calendar\": {\n \"type\": \"microsoft\",\n \"emailAddress\": \"\"\n },\n \"notes\": \"\",\n \"hotdeskingStatus\": \"on\",\n \"supportedDevices\": \"collaborationDevices\",\n \"deviceHostedMeetings\": {\n \"enabled\": \"\",\n \"siteUrl\": \"\"\n },\n \"devicePlatform\": \"microsoftTeamsRoom\",\n \"indoorNavigation\": {\n \"url\": \"\"\n },\n \"health\": {\n \"level\": \"info\",\n \"issues\": [\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"recommendedAction\": \"\",\n \"level\": {\n \"Members\": \"warning\"\n }\n },\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"recommendedAction\": \"\",\n \"level\": {\n \"Members\": \"error\"\n }\n }\n ]\n },\n \"devices\": [\n {\n \"created\": \"\",\n \"id\": \"\",\n \"displayName\": \"\",\n \"placeId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"capabilities\": [\n \"xapi\",\n \"xapi\"\n ],\n \"permissions\": [\n \"xapi:readonly\",\n \"xapi:readonly\"\n ],\n \"connectionStatus\": \"connected_with_issues\",\n \"product\": \"\",\n \"type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"ip\": \"\",\n \"activeInterface\": \"wired\",\n \"mac\": \"\",\n \"primarySipUrl\": \"\",\n \"sipUrls\": [\n \"\",\n \"\"\n ],\n \"serial\": \"\",\n \"software\": \"\",\n \"upgradeChannel\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"errorCodes\": [\n \"\",\n \"\"\n ],\n \"firstSeen\": \"\",\n \"lastSeen\": \"\",\n \"managedBy\": \"CUSTOMER\",\n \"devicePlatform\": \"cisco\",\n \"plannedMaintenance\": {\n \"mode\": \"on\"\n }\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"displayName\": \"\",\n \"placeId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"capabilities\": [\n \"xapi\",\n \"xapi\"\n ],\n \"permissions\": [\n \"xapi:readonly\",\n \"xapi:readonly\"\n ],\n \"connectionStatus\": \"disconnected\",\n \"product\": \"\",\n \"type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"ip\": \"\",\n \"activeInterface\": \"wired\",\n \"mac\": \"\",\n \"primarySipUrl\": \"\",\n \"sipUrls\": [\n \"\",\n \"\"\n ],\n \"serial\": \"\",\n \"software\": \"\",\n \"upgradeChannel\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"errorCodes\": [\n \"\",\n \"\"\n ],\n \"firstSeen\": \"\",\n \"lastSeen\": \"\",\n \"managedBy\": \"PARTNER\",\n \"devicePlatform\": \"cisco\",\n \"plannedMaintenance\": {\n \"mode\": \"off\"\n }\n }\n ],\n \"capabilities\": [\n {\n \"occupancyDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"presenceDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"ambientNoise\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"soundLevel\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"temperature\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"airQuality\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"relativeHumidity\": {\n \"supported\": \"\",\n \"configured\": \"\"\n }\n },\n {\n \"occupancyDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"presenceDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"ambientNoise\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"soundLevel\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"temperature\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"airQuality\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"relativeHumidity\": {\n \"supported\": \"\",\n \"configured\": \"\"\n }\n }\n ],\n \"plannedMaintenance\": {\n \"mode\": \"on\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n}", + "body": "{\n \"id\": \"\",\n \"orgId\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"floorId\": \"\",\n \"displayName\": \"\",\n \"capacity\": \"\",\n \"type\": \"meetingRoom\",\n \"sipAddress\": \"\",\n \"created\": \"\",\n \"calling\": {\n \"type\": \"thirdPartySipCalling\",\n \"hybridCalling\": {\n \"emailAddress\": \"\"\n },\n \"webexCalling\": {\n \"licenses\": [\n \"\",\n \"\"\n ]\n }\n },\n \"calendar\": {\n \"type\": \"microsoft\",\n \"emailAddress\": \"\"\n },\n \"notes\": \"\",\n \"hotdeskingStatus\": \"on\",\n \"supportedDevices\": \"collaborationDevices\",\n \"deviceHostedMeetings\": {\n \"enabled\": \"\",\n \"siteUrl\": \"\"\n },\n \"devicePlatform\": \"microsoftTeamsRoom\",\n \"indoorNavigation\": {\n \"url\": \"\"\n },\n \"health\": {\n \"level\": \"info\",\n \"issues\": [\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"recommendedAction\": \"\",\n \"level\": {\n \"Members\": \"warning\"\n }\n },\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"recommendedAction\": \"\",\n \"level\": {\n \"Members\": \"error\"\n }\n }\n ]\n },\n \"devices\": [\n {\n \"created\": \"\",\n \"id\": \"\",\n \"displayName\": \"\",\n \"placeId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"capabilities\": [\n \"xapi\",\n \"xapi\"\n ],\n \"permissions\": [\n \"xapi:readonly\",\n \"xapi:readonly\"\n ],\n \"connectionStatus\": \"connected_with_issues\",\n \"product\": \"\",\n \"type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"ip\": \"\",\n \"activeInterface\": \"wired\",\n \"mac\": \"\",\n \"primarySipUrl\": \"\",\n \"sipUrls\": [\n \"\",\n \"\"\n ],\n \"serial\": \"\",\n \"software\": \"\",\n \"upgradeChannel\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"errorCodes\": [\n \"\",\n \"\"\n ],\n \"firstSeen\": \"\",\n \"lastSeen\": \"\",\n \"managedBy\": \"CUSTOMER\",\n \"devicePlatform\": \"cisco\",\n \"plannedMaintenance\": {\n \"mode\": \"on\"\n }\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"displayName\": \"\",\n \"placeId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"capabilities\": [\n \"xapi\",\n \"xapi\"\n ],\n \"permissions\": [\n \"xapi:readonly\",\n \"xapi:readonly\"\n ],\n \"connectionStatus\": \"disconnected\",\n \"product\": \"\",\n \"type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"ip\": \"\",\n \"activeInterface\": \"wired\",\n \"mac\": \"\",\n \"primarySipUrl\": \"\",\n \"sipUrls\": [\n \"\",\n \"\"\n ],\n \"serial\": \"\",\n \"software\": \"\",\n \"upgradeChannel\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"errorCodes\": [\n \"\",\n \"\"\n ],\n \"firstSeen\": \"\",\n \"lastSeen\": \"\",\n \"managedBy\": \"PARTNER\",\n \"devicePlatform\": \"cisco\",\n \"plannedMaintenance\": {\n \"mode\": \"off\"\n }\n }\n ],\n \"capabilities\": [\n {\n \"occupancyDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"presenceDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"ambientNoise\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"soundLevel\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"temperature\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"airQuality\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"relativeHumidity\": {\n \"supported\": \"\",\n \"configured\": \"\"\n }\n },\n {\n \"occupancyDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"presenceDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"ambientNoise\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"soundLevel\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"temperature\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"airQuality\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"relativeHumidity\": {\n \"supported\": \"\",\n \"configured\": \"\"\n }\n }\n ],\n \"plannedMaintenance\": {\n \"mode\": \"on\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"message\": \"\"\n }\n}", "code": 201, "cookie": [], "header": [ @@ -58888,7 +58888,7 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"orgId\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"floorId\": \"\",\n \"displayName\": \"\",\n \"capacity\": \"\",\n \"type\": \"meetingRoom\",\n \"sipAddress\": \"\",\n \"created\": \"\",\n \"calling\": {\n \"type\": \"thirdPartySipCalling\",\n \"hybridCalling\": {\n \"emailAddress\": \"\"\n },\n \"webexCalling\": {\n \"licenses\": [\n \"\",\n \"\"\n ]\n }\n },\n \"calendar\": {\n \"type\": \"microsoft\",\n \"emailAddress\": \"\"\n },\n \"notes\": \"\",\n \"hotdeskingStatus\": \"on\",\n \"supportedDevices\": \"collaborationDevices\",\n \"deviceHostedMeetings\": {\n \"enabled\": \"\",\n \"siteUrl\": \"\"\n },\n \"devicePlatform\": \"microsoftTeamsRoom\",\n \"indoorNavigation\": {\n \"url\": \"\"\n },\n \"health\": {\n \"level\": \"info\",\n \"issues\": [\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"recommendedAction\": \"\",\n \"level\": {\n \"Members\": \"warning\"\n }\n },\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"recommendedAction\": \"\",\n \"level\": {\n \"Members\": \"error\"\n }\n }\n ]\n },\n \"devices\": [\n {\n \"created\": \"\",\n \"id\": \"\",\n \"displayName\": \"\",\n \"placeId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"capabilities\": [\n \"xapi\",\n \"xapi\"\n ],\n \"permissions\": [\n \"xapi:readonly\",\n \"xapi:readonly\"\n ],\n \"connectionStatus\": \"connected_with_issues\",\n \"product\": \"\",\n \"type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"ip\": \"\",\n \"activeInterface\": \"wired\",\n \"mac\": \"\",\n \"primarySipUrl\": \"\",\n \"sipUrls\": [\n \"\",\n \"\"\n ],\n \"serial\": \"\",\n \"software\": \"\",\n \"upgradeChannel\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"errorCodes\": [\n \"\",\n \"\"\n ],\n \"firstSeen\": \"\",\n \"lastSeen\": \"\",\n \"managedBy\": \"CUSTOMER\",\n \"devicePlatform\": \"cisco\",\n \"plannedMaintenance\": {\n \"mode\": \"on\"\n }\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"displayName\": \"\",\n \"placeId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"capabilities\": [\n \"xapi\",\n \"xapi\"\n ],\n \"permissions\": [\n \"xapi:readonly\",\n \"xapi:readonly\"\n ],\n \"connectionStatus\": \"disconnected\",\n \"product\": \"\",\n \"type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"ip\": \"\",\n \"activeInterface\": \"wired\",\n \"mac\": \"\",\n \"primarySipUrl\": \"\",\n \"sipUrls\": [\n \"\",\n \"\"\n ],\n \"serial\": \"\",\n \"software\": \"\",\n \"upgradeChannel\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"errorCodes\": [\n \"\",\n \"\"\n ],\n \"firstSeen\": \"\",\n \"lastSeen\": \"\",\n \"managedBy\": \"PARTNER\",\n \"devicePlatform\": \"cisco\",\n \"plannedMaintenance\": {\n \"mode\": \"off\"\n }\n }\n ],\n \"capabilities\": [\n {\n \"occupancyDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"presenceDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"ambientNoise\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"soundLevel\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"temperature\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"airQuality\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"relativeHumidity\": {\n \"supported\": \"\",\n \"configured\": \"\"\n }\n },\n {\n \"occupancyDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"presenceDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"ambientNoise\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"soundLevel\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"temperature\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"airQuality\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"relativeHumidity\": {\n \"supported\": \"\",\n \"configured\": \"\"\n }\n }\n ],\n \"plannedMaintenance\": {\n \"mode\": \"on\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n}", + "body": "{\n \"id\": \"\",\n \"orgId\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"floorId\": \"\",\n \"displayName\": \"\",\n \"capacity\": \"\",\n \"type\": \"meetingRoom\",\n \"sipAddress\": \"\",\n \"created\": \"\",\n \"calling\": {\n \"type\": \"thirdPartySipCalling\",\n \"hybridCalling\": {\n \"emailAddress\": \"\"\n },\n \"webexCalling\": {\n \"licenses\": [\n \"\",\n \"\"\n ]\n }\n },\n \"calendar\": {\n \"type\": \"microsoft\",\n \"emailAddress\": \"\"\n },\n \"notes\": \"\",\n \"hotdeskingStatus\": \"on\",\n \"supportedDevices\": \"collaborationDevices\",\n \"deviceHostedMeetings\": {\n \"enabled\": \"\",\n \"siteUrl\": \"\"\n },\n \"devicePlatform\": \"microsoftTeamsRoom\",\n \"indoorNavigation\": {\n \"url\": \"\"\n },\n \"health\": {\n \"level\": \"info\",\n \"issues\": [\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"recommendedAction\": \"\",\n \"level\": {\n \"Members\": \"warning\"\n }\n },\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"recommendedAction\": \"\",\n \"level\": {\n \"Members\": \"error\"\n }\n }\n ]\n },\n \"devices\": [\n {\n \"created\": \"\",\n \"id\": \"\",\n \"displayName\": \"\",\n \"placeId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"capabilities\": [\n \"xapi\",\n \"xapi\"\n ],\n \"permissions\": [\n \"xapi:readonly\",\n \"xapi:readonly\"\n ],\n \"connectionStatus\": \"connected_with_issues\",\n \"product\": \"\",\n \"type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"ip\": \"\",\n \"activeInterface\": \"wired\",\n \"mac\": \"\",\n \"primarySipUrl\": \"\",\n \"sipUrls\": [\n \"\",\n \"\"\n ],\n \"serial\": \"\",\n \"software\": \"\",\n \"upgradeChannel\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"errorCodes\": [\n \"\",\n \"\"\n ],\n \"firstSeen\": \"\",\n \"lastSeen\": \"\",\n \"managedBy\": \"CUSTOMER\",\n \"devicePlatform\": \"cisco\",\n \"plannedMaintenance\": {\n \"mode\": \"on\"\n }\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"displayName\": \"\",\n \"placeId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"capabilities\": [\n \"xapi\",\n \"xapi\"\n ],\n \"permissions\": [\n \"xapi:readonly\",\n \"xapi:readonly\"\n ],\n \"connectionStatus\": \"disconnected\",\n \"product\": \"\",\n \"type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"ip\": \"\",\n \"activeInterface\": \"wired\",\n \"mac\": \"\",\n \"primarySipUrl\": \"\",\n \"sipUrls\": [\n \"\",\n \"\"\n ],\n \"serial\": \"\",\n \"software\": \"\",\n \"upgradeChannel\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"errorCodes\": [\n \"\",\n \"\"\n ],\n \"firstSeen\": \"\",\n \"lastSeen\": \"\",\n \"managedBy\": \"PARTNER\",\n \"devicePlatform\": \"cisco\",\n \"plannedMaintenance\": {\n \"mode\": \"off\"\n }\n }\n ],\n \"capabilities\": [\n {\n \"occupancyDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"presenceDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"ambientNoise\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"soundLevel\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"temperature\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"airQuality\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"relativeHumidity\": {\n \"supported\": \"\",\n \"configured\": \"\"\n }\n },\n {\n \"occupancyDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"presenceDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"ambientNoise\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"soundLevel\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"temperature\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"airQuality\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"relativeHumidity\": {\n \"supported\": \"\",\n \"configured\": \"\"\n }\n }\n ],\n \"plannedMaintenance\": {\n \"mode\": \"on\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"message\": \"\"\n }\n}", "code": 200, "cookie": [], "header": [ @@ -60700,7 +60700,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"orgId\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"floorId\": \"\",\n \"displayName\": \"\",\n \"capacity\": \"\",\n \"type\": \"meetingRoom\",\n \"sipAddress\": \"\",\n \"created\": \"\",\n \"calling\": {\n \"type\": \"thirdPartySipCalling\",\n \"hybridCalling\": {\n \"emailAddress\": \"\"\n },\n \"webexCalling\": {\n \"licenses\": [\n \"\",\n \"\"\n ]\n }\n },\n \"calendar\": {\n \"type\": \"microsoft\",\n \"emailAddress\": \"\"\n },\n \"notes\": \"\",\n \"hotdeskingStatus\": \"on\",\n \"supportedDevices\": \"collaborationDevices\",\n \"deviceHostedMeetings\": {\n \"enabled\": \"\",\n \"siteUrl\": \"\"\n },\n \"devicePlatform\": \"microsoftTeamsRoom\",\n \"indoorNavigation\": {\n \"url\": \"\"\n },\n \"health\": {\n \"level\": \"info\",\n \"issues\": [\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"recommendedAction\": \"\",\n \"level\": {\n \"Members\": \"warning\"\n }\n },\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"recommendedAction\": \"\",\n \"level\": {\n \"Members\": \"error\"\n }\n }\n ]\n },\n \"devices\": [\n {\n \"created\": \"\",\n \"id\": \"\",\n \"displayName\": \"\",\n \"placeId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"capabilities\": [\n \"xapi\",\n \"xapi\"\n ],\n \"permissions\": [\n \"xapi:readonly\",\n \"xapi:readonly\"\n ],\n \"connectionStatus\": \"connected_with_issues\",\n \"product\": \"\",\n \"type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"ip\": \"\",\n \"activeInterface\": \"wired\",\n \"mac\": \"\",\n \"primarySipUrl\": \"\",\n \"sipUrls\": [\n \"\",\n \"\"\n ],\n \"serial\": \"\",\n \"software\": \"\",\n \"upgradeChannel\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"errorCodes\": [\n \"\",\n \"\"\n ],\n \"firstSeen\": \"\",\n \"lastSeen\": \"\",\n \"managedBy\": \"CUSTOMER\",\n \"devicePlatform\": \"cisco\",\n \"plannedMaintenance\": {\n \"mode\": \"on\"\n }\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"displayName\": \"\",\n \"placeId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"capabilities\": [\n \"xapi\",\n \"xapi\"\n ],\n \"permissions\": [\n \"xapi:readonly\",\n \"xapi:readonly\"\n ],\n \"connectionStatus\": \"disconnected\",\n \"product\": \"\",\n \"type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"ip\": \"\",\n \"activeInterface\": \"wired\",\n \"mac\": \"\",\n \"primarySipUrl\": \"\",\n \"sipUrls\": [\n \"\",\n \"\"\n ],\n \"serial\": \"\",\n \"software\": \"\",\n \"upgradeChannel\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"errorCodes\": [\n \"\",\n \"\"\n ],\n \"firstSeen\": \"\",\n \"lastSeen\": \"\",\n \"managedBy\": \"PARTNER\",\n \"devicePlatform\": \"cisco\",\n \"plannedMaintenance\": {\n \"mode\": \"off\"\n }\n }\n ],\n \"capabilities\": [\n {\n \"occupancyDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"presenceDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"ambientNoise\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"soundLevel\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"temperature\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"airQuality\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"relativeHumidity\": {\n \"supported\": \"\",\n \"configured\": \"\"\n }\n },\n {\n \"occupancyDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"presenceDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"ambientNoise\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"soundLevel\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"temperature\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"airQuality\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"relativeHumidity\": {\n \"supported\": \"\",\n \"configured\": \"\"\n }\n }\n ],\n \"plannedMaintenance\": {\n \"mode\": \"on\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n}", + "body": "{\n \"id\": \"\",\n \"orgId\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"floorId\": \"\",\n \"displayName\": \"\",\n \"capacity\": \"\",\n \"type\": \"meetingRoom\",\n \"sipAddress\": \"\",\n \"created\": \"\",\n \"calling\": {\n \"type\": \"thirdPartySipCalling\",\n \"hybridCalling\": {\n \"emailAddress\": \"\"\n },\n \"webexCalling\": {\n \"licenses\": [\n \"\",\n \"\"\n ]\n }\n },\n \"calendar\": {\n \"type\": \"microsoft\",\n \"emailAddress\": \"\"\n },\n \"notes\": \"\",\n \"hotdeskingStatus\": \"on\",\n \"supportedDevices\": \"collaborationDevices\",\n \"deviceHostedMeetings\": {\n \"enabled\": \"\",\n \"siteUrl\": \"\"\n },\n \"devicePlatform\": \"microsoftTeamsRoom\",\n \"indoorNavigation\": {\n \"url\": \"\"\n },\n \"health\": {\n \"level\": \"info\",\n \"issues\": [\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"recommendedAction\": \"\",\n \"level\": {\n \"Members\": \"warning\"\n }\n },\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"recommendedAction\": \"\",\n \"level\": {\n \"Members\": \"error\"\n }\n }\n ]\n },\n \"devices\": [\n {\n \"created\": \"\",\n \"id\": \"\",\n \"displayName\": \"\",\n \"placeId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"capabilities\": [\n \"xapi\",\n \"xapi\"\n ],\n \"permissions\": [\n \"xapi:readonly\",\n \"xapi:readonly\"\n ],\n \"connectionStatus\": \"connected_with_issues\",\n \"product\": \"\",\n \"type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"ip\": \"\",\n \"activeInterface\": \"wired\",\n \"mac\": \"\",\n \"primarySipUrl\": \"\",\n \"sipUrls\": [\n \"\",\n \"\"\n ],\n \"serial\": \"\",\n \"software\": \"\",\n \"upgradeChannel\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"errorCodes\": [\n \"\",\n \"\"\n ],\n \"firstSeen\": \"\",\n \"lastSeen\": \"\",\n \"managedBy\": \"CUSTOMER\",\n \"devicePlatform\": \"cisco\",\n \"plannedMaintenance\": {\n \"mode\": \"on\"\n }\n },\n {\n \"created\": \"\",\n \"id\": \"\",\n \"displayName\": \"\",\n \"placeId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"orgId\": \"\",\n \"capabilities\": [\n \"xapi\",\n \"xapi\"\n ],\n \"permissions\": [\n \"xapi:readonly\",\n \"xapi:readonly\"\n ],\n \"connectionStatus\": \"disconnected\",\n \"product\": \"\",\n \"type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"ip\": \"\",\n \"activeInterface\": \"wired\",\n \"mac\": \"\",\n \"primarySipUrl\": \"\",\n \"sipUrls\": [\n \"\",\n \"\"\n ],\n \"serial\": \"\",\n \"software\": \"\",\n \"upgradeChannel\": \"\",\n \"locationId\": \"\",\n \"workspaceLocationId\": \"\",\n \"errorCodes\": [\n \"\",\n \"\"\n ],\n \"firstSeen\": \"\",\n \"lastSeen\": \"\",\n \"managedBy\": \"PARTNER\",\n \"devicePlatform\": \"cisco\",\n \"plannedMaintenance\": {\n \"mode\": \"off\"\n }\n }\n ],\n \"capabilities\": [\n {\n \"occupancyDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"presenceDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"ambientNoise\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"soundLevel\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"temperature\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"airQuality\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"relativeHumidity\": {\n \"supported\": \"\",\n \"configured\": \"\"\n }\n },\n {\n \"occupancyDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"presenceDetection\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"ambientNoise\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"soundLevel\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"temperature\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"airQuality\": {\n \"supported\": \"\",\n \"configured\": \"\"\n },\n \"relativeHumidity\": {\n \"supported\": \"\",\n \"configured\": \"\"\n }\n }\n ],\n \"plannedMaintenance\": {\n \"mode\": \"on\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"message\": \"\"\n }\n}", "code": 200, "cookie": [], "header": [ @@ -63175,7 +63175,7 @@ }, { "_postman_previewlanguage": "json", - "body": "[\n {\n \"deviceId\": \"\",\n \"status\": {\n \"key_0\": {\n \"schema\": {}\n },\n \"key_1\": {\n \"schema\": {}\n },\n \"key_2\": {\n \"schema\": {}\n }\n },\n \"commands\": {\n \"key_0\": {\n \"arguments\": {\n \"key_0\": {\n \"required\": \"\",\n \"schema\": {}\n },\n \"key_1\": {\n \"required\": \"\",\n \"schema\": {}\n },\n \"key_2\": {\n \"required\": \"\",\n \"schema\": {}\n }\n },\n \"resultSchema\": {},\n \"bodySchema\": {\n \"schema\": {}\n }\n }\n }\n },\n {\n \"deviceId\": \"\",\n \"status\": {\n \"key_0\": {\n \"schema\": {}\n }\n },\n \"commands\": {\n \"key_0\": {\n \"arguments\": {\n \"key_0\": {\n \"required\": \"\",\n \"schema\": {}\n },\n \"key_1\": {\n \"required\": \"\",\n \"schema\": {}\n }\n },\n \"resultSchema\": {},\n \"bodySchema\": {\n \"schema\": {}\n }\n },\n \"key_1\": {\n \"arguments\": {\n \"key_0\": {\n \"required\": \"\",\n \"schema\": {}\n },\n \"key_1\": {\n \"required\": \"\",\n \"schema\": {}\n }\n },\n \"resultSchema\": {},\n \"bodySchema\": {\n \"schema\": {}\n }\n },\n \"key_2\": {\n \"arguments\": {\n \"key_0\": {\n \"required\": \"\",\n \"schema\": {}\n },\n \"key_1\": {\n \"required\": \"\",\n \"schema\": {}\n }\n },\n \"resultSchema\": {},\n \"bodySchema\": {\n \"schema\": {}\n }\n }\n }\n }\n]", + "body": "[\n {\n \"deviceId\": \"\",\n \"status\": {\n \"key_0\": {\n \"schema\": {}\n },\n \"key_1\": {\n \"schema\": {}\n },\n \"key_2\": {\n \"schema\": {}\n },\n \"key_3\": {\n \"schema\": {}\n }\n },\n \"commands\": {\n \"key_0\": {\n \"arguments\": {\n \"key_0\": {\n \"required\": \"\",\n \"schema\": {}\n },\n \"key_1\": {\n \"required\": \"\",\n \"schema\": {}\n }\n },\n \"resultSchema\": {},\n \"bodySchema\": {\n \"schema\": {}\n }\n },\n \"key_1\": {\n \"arguments\": {\n \"key_0\": {\n \"required\": \"\",\n \"schema\": {}\n },\n \"key_1\": {\n \"required\": \"\",\n \"schema\": {}\n }\n },\n \"resultSchema\": {},\n \"bodySchema\": {\n \"schema\": {}\n }\n }\n }\n },\n {\n \"deviceId\": \"\",\n \"status\": {\n \"key_0\": {\n \"schema\": {}\n }\n },\n \"commands\": {\n \"key_0\": {\n \"arguments\": {\n \"key_0\": {\n \"required\": \"\",\n \"schema\": {}\n }\n },\n \"resultSchema\": {},\n \"bodySchema\": {\n \"schema\": {}\n }\n },\n \"key_1\": {\n \"arguments\": {\n \"key_0\": {\n \"required\": \"\",\n \"schema\": {}\n }\n },\n \"resultSchema\": {},\n \"bodySchema\": {\n \"schema\": {}\n }\n },\n \"key_2\": {\n \"arguments\": {\n \"key_0\": {\n \"required\": \"\",\n \"schema\": {}\n },\n \"key_1\": {\n \"required\": \"\",\n \"schema\": {}\n }\n },\n \"resultSchema\": {},\n \"bodySchema\": {\n \"schema\": {}\n }\n },\n \"key_3\": {\n \"arguments\": {\n \"key_0\": {\n \"required\": \"\",\n \"schema\": {}\n },\n \"key_1\": {\n \"required\": \"\",\n \"schema\": {}\n }\n },\n \"resultSchema\": {},\n \"bodySchema\": {\n \"schema\": {}\n }\n }\n }\n }\n]", "code": 200, "cookie": [], "header": [ diff --git a/codegen/postman/Webex Meetings.postman_collection.json b/codegen/postman/Webex Meetings.postman_collection.json index 85cea17..d7744d5 100644 --- a/codegen/postman/Webex Meetings.postman_collection.json +++ b/codegen/postman/Webex Meetings.postman_collection.json @@ -43176,7 +43176,7 @@ }, "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoin\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"hostEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowAll\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"beep\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"focusedContent\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, - "description": "Updates details for a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be updated.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation updates that scheduled meeting without impact on other scheduled meeting of the parent meeting series.\n\n* If the `meetingId` value specified is for a meeting series, the operation updates the entire meeting series. **Note**: If the value of `start`, `end`, or `recurrence` for the meeting series is changed, any exceptional scheduled meeting in this series is cancelled when the meeting series is updated.\n\n* The `agenda`, `recurrence`, and `trackingCodes` attributes can be specified as `null` so that these attributes become null and hidden from the response after the patch. Note that it's the keyword `null` not the string \"null\".\n\n* If the parameter `recurrence` has a value, a recurring meeting is created based on the rule defined by the value of `recurrence`. For a non-recurring meeting which has no `recurrence` value set, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling. If you specify a `recurrence` like `FREQ=DAILY;INTERVAL=1` which never ends, the furthest date of the series is unlimited. You can also specify a `recurrence` with a very distant ending date in the future, e.g. `FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z`, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting.\n\n* You can't update a meeting that starts 10 years or more in the future.\n\n* Updating a meeting in the API that was created via a calendar connector is not allowed. The meeting may be updated in Webex, but the calendar event may not be updated, resulting in duplicate entries. This action is therefore blocked. In case you must overwrite this behavior, please contact devsupport@webex.com.", + "description": "
\nIf only guests are waiting in the lobby and the host or cohost has not started the meeting, the meeting state remains `inProgress` for 5 minutes after the last guest leaves. The meeting cannot be patched during this time. If the meeting is started by the host or cohost and then ended normally, it can be patched immediately after it ends.\n
\n\nUpdates details for a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be updated.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation updates that scheduled meeting without impact on other scheduled meeting of the parent meeting series.\n\n* If the `meetingId` value specified is for a meeting series, the operation updates the entire meeting series. **Note**: If the value of `start`, `end`, or `recurrence` for the meeting series is changed, any exceptional scheduled meeting in this series is cancelled when the meeting series is updated.\n\n* The `agenda`, `recurrence`, and `trackingCodes` attributes can be specified as `null` so that these attributes become null and hidden from the response after the patch. Note that it's the keyword `null` not the string \"null\".\n\n* If the parameter `recurrence` has a value, a recurring meeting is created based on the rule defined by the value of `recurrence`. For a non-recurring meeting which has no `recurrence` value set, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling. If you specify a `recurrence` like `FREQ=DAILY;INTERVAL=1` which never ends, the furthest date of the series is unlimited. You can also specify a `recurrence` with a very distant ending date in the future, e.g. `FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z`, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting.\n\n* You can't update a meeting that starts 10 years or more in the future.\n\n* Updating a meeting in the API that was created via a calendar connector is not allowed. The meeting may be updated in Webex, but the calendar event may not be updated, resulting in duplicate entries. This action is therefore blocked. In case you must overwrite this behavior, please contact devsupport@webex.com.", "header": [ { "key": "Content-Type", @@ -43935,7 +43935,7 @@ }, "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"blockFromJoin\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"hostEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"stack\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, - "description": "
\nThe PUT method is still supported and behaves the same as before, will be deprecated in the future. Use the PATCH method instead.\n
\n\nUpdates details for a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be updated.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation updates that scheduled meeting without impact on other scheduled meeting of the parent meeting series.\n\n* If the `meetingId` value specified is for a meeting series, the operation updates the entire meeting series. **Note**: If the value of `start`, `end`, or `recurrence` for the meeting series is changed, any exceptional scheduled meeting in this series is cancelled when the meeting series is updated.\n\n* If the parameter `recurrence` has a value, a recurring meeting is created based on the rule defined by the value of `recurrence`. For a non-recurring meeting which has no `recurrence` value set, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling. If you specify a `recurrence` like `FREQ=DAILY;INTERVAL=1` which never ends, the furthest date of the series is unlimited. You can also specify a `recurrence` with a very distant ending date in the future, e.g. `FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z`, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting.\n\n* You can't update a meeting that starts 10 years or more in the future.\n\n* Updating a meeting created using the API via a calendar connector is not supported. While the meeting may be updated in Webex, the calendar event may not be updated resulting in duplicate entries. If you need to override this behavior, contact devsupport@webex.com.", + "description": "
\nThe PUT method is still supported and behaves the same as before, will be deprecated in the future. Use the PATCH method instead.\n
\n\n
\nIf only guests are waiting in the lobby and the host or cohost has not started the meeting, the meeting state remains `inProgress` for 5 minutes after the last guest leaves. The meeting cannot be updated during this time. If the meeting is started by the host or cohost and then ended normally, it can be updated immediately after it ends.\n
\n\nUpdates details for a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be updated.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation updates that scheduled meeting without impact on other scheduled meeting of the parent meeting series.\n\n* If the `meetingId` value specified is for a meeting series, the operation updates the entire meeting series. **Note**: If the value of `start`, `end`, or `recurrence` for the meeting series is changed, any exceptional scheduled meeting in this series is cancelled when the meeting series is updated.\n\n* If the parameter `recurrence` has a value, a recurring meeting is created based on the rule defined by the value of `recurrence`. For a non-recurring meeting which has no `recurrence` value set, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling. If you specify a `recurrence` like `FREQ=DAILY;INTERVAL=1` which never ends, the furthest date of the series is unlimited. You can also specify a `recurrence` with a very distant ending date in the future, e.g. `FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z`, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting.\n\n* You can't update a meeting that starts 10 years or more in the future.\n\n* Updating a meeting created using the API via a calendar connector is not supported. While the meeting may be updated in Webex, the calendar event may not be updated resulting in duplicate entries. If you need to override this behavior, contact devsupport@webex.com.", "header": [ { "key": "Content-Type", @@ -44684,7 +44684,7 @@ { "name": "Delete a Meeting", "request": { - "description": "Deletes a meeting with a specified meeting ID. The deleted meeting cannot be recovered. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be deleted.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation deletes that scheduled meeting without impact on other scheduled meeting of the parent meeting series.\n\n* If the `meetingId` value specified is for a meeting series, the operation deletes the entire meeting series.", + "description": "
\nIf only guests are waiting in the lobby and the host or cohost has not started the meeting, the meeting state remains `inProgress` for 5 minutes after the last guest leaves. The meeting cannot be deleted during this time. If the meeting is started by the host or cohost and then ended normally, it can be deleted immediately after it ends.\n
\n\nDeletes a meeting with a specified meeting ID. The deleted meeting cannot be recovered. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be deleted.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation deletes that scheduled meeting without impact on other scheduled meeting of the parent meeting series.\n\n* If the `meetingId` value specified is for a meeting series, the operation deletes the entire meeting series.", "header": [], "method": "DELETE", "url": { @@ -76195,20 +76195,25 @@ "status": "Bad Request" } ] - } - ], - "name": "Meetings" - }, - { - "item": [ + }, { - "name": "List Tracking Codes", + "name": "List Group Meetings", "request": { - "description": "Lists tracking codes on a site by an admin user.\n\n* If `siteUrl` is specified, tracking codes of the specified site will be listed; otherwise, tracking codes of the user's preferred site will be listed. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub. This is a one-time irreversible operation. Once the tracking codes are mapped to custom or user profile attributes, the response returns the mapped tracking codes.", + "description": "List group meetings with a specified meeting number or web link by a service app which has group meeting access. You can specify the `personId` parameter or `hostEmail` header of whom the meetings will be retrieved. Please note that there are various products in the [Webex Suite](https://www.webex.com/collaboration-suite.html) such as `Meetings` and `Events`. Currently, only meetings of the `Meetings` product are supported by this API, meetings of others in the suite are not supported. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` will not be listed.\n\n* One of the `personId` parameter and `hostEmail` header must be specified so that only meetings hosted by the person of `personId` or `hostEmail` will be listed.\n\n* `meetingNumber` and `webLink` are mutually exclusive and they cannot be specified simultaneously, but one of them must be specified. The operation returns an array of meeting objects specified by the `meetingNumber` or `webLink`.\n\n* Each object in the array can be a scheduled meeting or a meeting series depending on whether the `current` parameter is `true` or `false`. If it's `false`, the `start` and `end` attributes are for the first scheduled meeting of that series. If it's `true` or not specified, the `start` and `end` attributes are for the scheduled meeting which is ready to start or join or the upcoming scheduled meeting of that series.\n\n* To learn more about which attributes are available for different meeting states, please refer to [Available Meeting Attributes for Different Meeting States](/docs/meetings#available-meeting-attributes-for-different-meeting-states).\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.\n\n* `hostEmail`: Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", "header": [ + { + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, { "key": "Accept", - "value": "application/json" + "value": "application/json;charset=UTF-8" } ], "method": "GET", @@ -76217,85 +76222,146 @@ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", + "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, "response": [ { "_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": [], + "header": [ + { + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", + "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Conflict" }, { "_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": [], + "header": [ + { + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", + "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, - "status": "Service Unavailable" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -76305,26 +76371,50 @@ "header": [], "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { - "header": [], + "header": [ + { + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", + "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, "status": "Bad Gateway" @@ -76332,212 +76422,357 @@ { "_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": [], + "header": [ + { + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", + "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, - "status": "Precondition Required" + "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": [], + "header": [ + { + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", + "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, - "status": "Unsupported Media Type" + "status": "Not Found" }, { "_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": [], + "header": [ + { + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", + "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 400, "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 Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { - "header": [], + "header": [ + { + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", + "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, - "status": "Conflict" + "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": [], + "header": [ + { + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", + "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, - "status": "Unauthorized" + "status": "Precondition Required" }, { "_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": [], + "header": [ + { + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", + "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"required\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"adminSet\"\n },\n {\n \"service\": \"EventCenter\",\n \"type\": \"adminSet\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"text\",\n \"hostProfileCode\": \"optional\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"optional\"\n },\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"optional\"\n }\n ]\n }\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" + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], "method": "GET", @@ -76546,219 +76781,394 @@ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", + "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, - "status": "OK" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { - "header": [], + "header": [ + { + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", + "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, - "status": "Forbidden" + "status": "Unsupported Media Type" }, { "_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": [], + "header": [ + { + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", + "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, - "status": "Too Many Requests" + "status": "Gateway Timeout" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 405, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingSeriesId\": \"\",\n \"title\": \"\",\n \"meetingType\": \"meeting\",\n \"state\": \"ended\",\n \"timezone\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"hostUserId\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"siteUrl\": \"\",\n \"telephony\": {\n \"callInNumbers\": [\n {\n \"label\": \"\",\n \"callInNumber\": \"\",\n \"tollType\": \"toll\"\n },\n {\n \"label\": \"\",\n \"callInNumber\": \"\",\n \"tollType\": \"toll\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\",\n \"method\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\",\n \"method\": \"\"\n }\n ]\n },\n \"enabledBreakoutSessions\": \"\",\n \"scheduledMeetingId\": \"\",\n \"meetingNumber\": \"\",\n \"hostDidJoin\": \"\",\n \"attendeeDidJoin\": \"\",\n \"isModified\": \"\",\n \"recurrence\": \"\",\n \"roomId\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"scheduledType\": \"personalRoomMeeting\",\n \"enabledWebcastView\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"hasChat\": \"\",\n \"hasRecording\": \"\",\n \"hasTranscription\": \"\",\n \"hasSummary\": \"\",\n \"hasClosedCaption\": \"\",\n \"hasPolls\": \"\",\n \"hasQA\": \"\",\n \"hasRegistration\": \"\",\n \"hasRegistrants\": \"\",\n \"hasPostEventSurvey\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowAll\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"simultaneousInterpretation\": {\n \"enabled\": \"\",\n \"interpreters\": [\n {\n \"id\": \"\",\n \"languageCode1\": \"\",\n \"languageCode2\": \"\",\n \"email\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"languageCode1\": \"\",\n \"languageCode2\": \"\",\n \"email\": \"\",\n \"displayName\": \"\"\n }\n ]\n },\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\",\n \"method\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\",\n \"method\": \"\"\n }\n ],\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"focusedContentWithActiveSpeaker\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"meetingSeriesId\": \"\",\n \"title\": \"\",\n \"meetingType\": \"meetingSeries\",\n \"state\": \"missed\",\n \"timezone\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"hostUserId\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"siteUrl\": \"\",\n \"telephony\": {\n \"callInNumbers\": [\n {\n \"label\": \"\",\n \"callInNumber\": \"\",\n \"tollType\": \"tollFree\"\n },\n {\n \"label\": \"\",\n \"callInNumber\": \"\",\n \"tollType\": \"toll\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\",\n \"method\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\",\n \"method\": \"\"\n }\n ]\n },\n \"enabledBreakoutSessions\": \"\",\n \"scheduledMeetingId\": \"\",\n \"meetingNumber\": \"\",\n \"hostDidJoin\": \"\",\n \"attendeeDidJoin\": \"\",\n \"isModified\": \"\",\n \"recurrence\": \"\",\n \"roomId\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoin\",\n \"sessionTypeId\": \"\",\n \"scheduledType\": \"meeting\",\n \"enabledWebcastView\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"hasChat\": \"\",\n \"hasRecording\": \"\",\n \"hasTranscription\": \"\",\n \"hasSummary\": \"\",\n \"hasClosedCaption\": \"\",\n \"hasPolls\": \"\",\n \"hasQA\": \"\",\n \"hasRegistration\": \"\",\n \"hasRegistrants\": \"\",\n \"hasPostEventSurvey\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowAll\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"simultaneousInterpretation\": {\n \"enabled\": \"\",\n \"interpreters\": [\n {\n \"id\": \"\",\n \"languageCode1\": \"\",\n \"languageCode2\": \"\",\n \"email\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"languageCode1\": \"\",\n \"languageCode2\": \"\",\n \"email\": \"\",\n \"displayName\": \"\"\n }\n ]\n },\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\",\n \"method\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\",\n \"method\": \"\"\n }\n ],\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"webexAudio\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"noTone\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"stack\",\n \"layoutWithSharedContent\": \"focusedContent\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n }\n ]\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;charset=UTF-8" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { - "header": [], + "header": [ + { + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", + "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, - "status": "Method Not Allowed" + "status": "OK" }, { "_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": { - "header": [], + "header": [ + { + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", + "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, - "status": "Gateway Timeout" + "status": "Method Not Allowed" }, { "_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": [], + "header": [ + { + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", + "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, - "status": "Gone" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 500, "cookie": [], "header": [], - "name": "Not Found", + "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": [], + "header": [ + { + "description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose meetings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meetings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.", + "key": "meetingNumber", "value": "" + }, + { + "description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.", + "key": "webLink", + "value": "" + }, + { + "description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.", + "key": "current", + "value": "true" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + "raw": "{{baseUrl}}/group/meetings?personId=&meetingNumber=&webLink=¤t=true" } }, - "status": "Not Found" + "status": "Internal Server Error" } ] }, { - "name": "Create a Tracking Code", + "name": "Patch a Group Meeting", "request": { "body": { "mode": "raw", @@ -76768,41 +77178,59 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, - "description": "Create a new tracking code by an admin user.\n\n* The `siteUrl` is required. The operation creates a tracking code for the specified site. All or a user's available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* The `inputMode` of `hostProfileSelect` is only available for a host profile and sign-up pages and does not apply to the meeting scheduler page or the meeting start page. The value for `scheduleStartCodes` must be `null` or the value for all services must be `notUsed` when the `inputMode` is `hostProfileSelect`.\n\n* The `hostProfileCode` of `required` is only allowed for a Site Admin managed site, and not for a Control Hub managed site.\n\n* When the `hostProfileCode` is `adminSet`, only `adminSet`, `notUsed`, and `notApplicable` are available for the types of `scheduleStartCodes`. When the `hostProfileCode` is not `adminSet`, only `optional`, `required`, `notUsed`, and `notApplicable` are available for `scheduleStartCodes`.\n\n* If the type of the `All` service has a value other than `notApplicable`, and another service, e.g. `EventCenter`, is missing from the `scheduleStartCodes`, then the type of this missing `EventCenter` service shares the same type as the `All` service. If the type of `All` service has a value other than `notApplicable`, and another service, e.g. `EventCenter`, has a type, then the type specified should be the same as the `All` service.\n\n* If the `All` service is missing from the `scheduleStartCodes`, any of the other four services, e.g. `EventCenter`, have a default type of `notUsed` if it is also missing from the `scheduleStartCodes`.\n\n* Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub, this is a one-time irreversible operation. Once the tracking codes are mapped to custom or user profile attributes, they cannot create tracking codes when the mapping process is in progress or the mapping process is completed.", + "description": "Patches details for a group meeting with a specified meeting ID by a service app which has group meeting access. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be updated.\n\n* One of the `personId` parameter and `hostEmail` header must be specified so that only meetings hosted by the person of `personId` or `hostEmail` will be patch.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation updates that scheduled meeting without impact on other scheduled meeting of the parent meeting series.\n\n* If the `meetingId` value specified is for a meeting series, the operation updates the entire meeting series. **Note**: If the value of `start`, `end`, or `recurrence` for the meeting series is changed, any exceptional scheduled meeting in this series is cancelled when the meeting series is updated.\n\n* The `agenda`, `recurrence`, and `trackingCodes` attributes can be specified as `null` so that these attributes become null and hidden from the response after the patch. Note that it's the keyword `null` not the string \"null\".\n\n* If the parameter `recurrence` has a value, a recurring meeting is created based on the rule defined by the value of `recurrence`. For a non-recurring meeting which has no `recurrence` value set, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling. If you specify a `recurrence` like `FREQ=DAILY;INTERVAL=1` which never ends, the furthest date of the series is unlimited. You can also specify a `recurrence` with a very distant ending date in the future, e.g. `FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z`, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting.\n\n* You can't update a meeting that starts 10 years or more in the future.\n\n* Updating a meeting in the API that was created via a calendar connector is not allowed. The meeting may be updated in Webex, but the calendar event may not be updated, resulting in duplicate entries. This action is therefore blocked. In case you must overwrite this behavior, please contact devsupport@webex.com.\n\n#### Request Header\n\n* `hostEmail`: Email of the user whose meeting will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", "header": [ + { + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" }, { "key": "Accept", - "value": "application/json" + "value": "application/json;charset=UTF-8" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, "response": [ { "_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", @@ -76812,37 +77240,55 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, "header": [ + { + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_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": { "body": { "mode": "raw", @@ -76852,37 +77298,55 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, "header": [ + { + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, - "status": "Not Found" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 401, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "body": { "mode": "raw", @@ -76892,37 +77356,55 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, "header": [ + { + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, - "status": "Gone" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 405, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -76932,37 +77414,55 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, "header": [ + { + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, - "status": "Unauthorized" + "status": "Method Not Allowed" }, { "_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", @@ -76972,37 +77472,60 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, "header": [ + { + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, - "status": "Unsupported Media Type" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 409, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"title\": \"\",\n \"password\": \"\",\n \"meetingType\": \"meetingSeries\",\n \"state\": \"scheduled\",\n \"timezone\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"hostUserId\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"hostKey\": \"\",\n \"siteUrl\": \"\",\n \"webLink\": \"\",\n \"telephony\": {\n \"accessCode\": \"\",\n \"callInNumbers\": [\n {\n \"label\": \"\",\n \"callInNumber\": \"\",\n \"tollType\": \"toll\"\n },\n {\n \"label\": \"\",\n \"callInNumber\": \"\",\n \"tollType\": \"toll\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\",\n \"method\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\",\n \"method\": \"\"\n }\n ]\n },\n \"enabledBreakoutSessions\": \"\",\n \"meetingNumber\": \"\",\n \"agenda\": \"\",\n \"phoneAndVideoSystemPassword\": \"\",\n \"hostDidJoin\": \"\",\n \"attendeeDidJoin\": \"\",\n \"recurrence\": \"\",\n \"registerLink\": \"\",\n \"sipAddress\": \"\",\n \"dialInIpAddress\": \"\",\n \"roomId\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"scheduledType\": \"webinar\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"phoneAndVideoSystemPanelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowAll\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"registration\": {\n \"autoAcceptRequest\": \"\",\n \"requireFirstName\": \"\",\n \"requireLastName\": \"\",\n \"requireEmail\": \"\",\n \"requireJobTitle\": \"\",\n \"requireCompanyName\": \"\",\n \"requireAddress1\": \"\",\n \"requireAddress2\": \"\",\n \"requireCity\": \"\",\n \"requireState\": \"\",\n \"requireZipCode\": \"\",\n \"requireCountryRegion\": \"\",\n \"requireWorkPhone\": \"\",\n \"requireFax\": \"\",\n \"maxRegisterNum\": \"\",\n \"customizedQuestions\": [\n {\n \"id\": \"\",\n \"question\": \"\",\n \"type\": \"checkbox\",\n \"required\": \"\",\n \"maxLength\": \"\",\n \"options\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"rules\": [\n {\n \"condition\": \"notContains\",\n \"value\": \"\",\n \"result\": \"reject\",\n \"order\": \"\",\n \"matchCase\": \"\"\n },\n {\n \"condition\": \"notEquals\",\n \"value\": \"\",\n \"result\": \"approve\",\n \"order\": \"\",\n \"matchCase\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"question\": \"\",\n \"type\": \"singleLineTextBox\",\n \"required\": \"\",\n \"maxLength\": \"\",\n \"options\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"rules\": [\n {\n \"condition\": \"notEquals\",\n \"value\": \"\",\n \"result\": \"reject\",\n \"order\": \"\",\n \"matchCase\": \"\"\n },\n {\n \"condition\": \"contains\",\n \"value\": \"\",\n \"result\": \"reject\",\n \"order\": \"\",\n \"matchCase\": \"\"\n }\n ]\n }\n ],\n \"rules\": [\n {\n \"question\": \"address1\",\n \"condition\": \"beginsWith\",\n \"value\": \"\",\n \"result\": \"reject\",\n \"order\": \"\",\n \"matchCase\": \"\"\n },\n {\n \"question\": \"address1\",\n \"condition\": \"notEquals\",\n \"value\": \"\",\n \"result\": \"approve\",\n \"order\": \"\",\n \"matchCase\": \"\"\n }\n ]\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"simultaneousInterpretation\": {\n \"enabled\": \"\",\n \"interpreters\": [\n {\n \"id\": \"\",\n \"languageCode1\": \"\",\n \"languageCode2\": \"\",\n \"email\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"languageCode1\": \"\",\n \"languageCode2\": \"\",\n \"email\": \"\",\n \"displayName\": \"\"\n }\n ]\n },\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\",\n \"method\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\",\n \"method\": \"\"\n }\n ],\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"VoIP\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"stack\",\n \"layoutWithSharedContent\": \"focusedContent\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}", + "code": 200, "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;charset=UTF-8" + } + ], + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -77012,37 +77535,59 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, "header": [ + { + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, - "status": "Conflict" + "status": "OK" }, { "_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": { "body": { "mode": "raw", @@ -77052,29 +77597,47 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, "header": [ + { + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, - "status": "Internal Server Error" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -77092,26 +77655,44 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, "header": [ + { + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, "status": "Bad Gateway" @@ -77119,10 +77700,10 @@ { "_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", @@ -77132,37 +77713,55 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, "header": [ + { + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, - "status": "Precondition Required" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 404, "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": "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", @@ -77172,37 +77771,55 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, "header": [ + { + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Not Found" }, { "_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", @@ -77212,37 +77829,55 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, "header": [ + { + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, - "status": "Gateway Timeout" + "status": "Internal Server Error" }, { "_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", @@ -77252,42 +77887,55 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, "header": [ + { + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, - "status": "Service Unavailable" + "status": "Unsupported Media Type" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json;charset=UTF-8" - } - ], - "name": "Bad Request", + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "body": { "mode": "raw", @@ -77297,41 +77945,55 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" }, { - "key": "Accept", - "value": "application/json;charset=UTF-8" + "key": "Content-Type", + "value": "application/json-patch+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_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": { "body": { "mode": "raw", @@ -77341,42 +78003,55 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, "header": [ + { + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, - "status": "Too Many Requests" + "status": "Precondition Required" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"text\",\n \"hostProfileCode\": \"required\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"required\"\n },\n {\n \"service\": \"SupportCenter\",\n \"type\": \"notApplicable\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 409, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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", @@ -77386,41 +78061,55 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" }, { - "key": "Accept", - "value": "application/json" + "key": "Content-Type", + "value": "application/json-patch+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, - "status": "OK" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 423, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "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", @@ -77430,188 +78119,248 @@ "language": "json" } }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + "raw": "{\n \"title\": \"\",\n \"agenda\": \"\",\n \"password\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"timezone\": \"\",\n \"recurrence\": \"\",\n \"enabledAutoRecordMeeting\": \"\",\n \"allowAnyUserToBeCoHost\": \"\",\n \"enabledJoinBeforeHost\": \"\",\n \"enableConnectAudioBeforeHost\": \"\",\n \"joinBeforeHostMinutes\": \"\",\n \"excludePassword\": \"\",\n \"publicMeeting\": \"\",\n \"reminderTime\": \"\",\n \"unlockedMeetingJoinSecurity\": \"allowJoinWithLobby\",\n \"sessionTypeId\": \"\",\n \"enabledWebcastView\": \"\",\n \"panelistPassword\": \"\",\n \"enableAutomaticLock\": \"\",\n \"automaticLockMinutes\": \"\",\n \"allowFirstUserToBeCoHost\": \"\",\n \"allowAuthenticatedDevices\": \"\",\n \"sendEmail\": \"\",\n \"meetingOptions\": {\n \"enabledChat\": \"\",\n \"enabledVideo\": \"\",\n \"enabledPolling\": \"\",\n \"enabledNote\": \"\",\n \"noteType\": \"allowOne\",\n \"enabledFileTransfer\": \"\",\n \"enabledUCFRichMedia\": \"\"\n },\n \"attendeePrivileges\": {\n \"enabledShareContent\": \"\",\n \"enabledSaveDocument\": \"\",\n \"enabledPrintDocument\": \"\",\n \"enabledAnnotate\": \"\",\n \"enabledViewParticipantList\": \"\",\n \"enabledViewThumbnails\": \"\",\n \"enabledRemoteControl\": \"\",\n \"enabledViewAnyDocument\": \"\",\n \"enabledViewAnyPage\": \"\",\n \"enabledContactOperatorPrivately\": \"\",\n \"enabledChatHost\": \"\",\n \"enabledChatPresenter\": \"\",\n \"enabledChatOtherParticipants\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ],\n \"enabledBreakoutSessions\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"enabledAudioWatermark\": \"\",\n \"enabledVisualWatermark\": \"\",\n \"visualWatermarkOpacity\": \"\",\n \"audioConnectionOptions\": {\n \"audioConnectionType\": \"other\",\n \"enabledTollFreeCallIn\": \"\",\n \"enabledGlobalCallIn\": \"\",\n \"enabledAudienceCallBack\": \"\",\n \"entryAndExitTone\": \"announceName\",\n \"allowHostToUnmuteParticipants\": \"\",\n \"allowAttendeeToUnmuteSelf\": \"\",\n \"muteAttendeeUponEntry\": \"\"\n },\n \"requireAttendeeLogin\": \"\",\n \"restrictToInvitees\": \"\",\n \"enabledLiveStream\": \"\",\n \"liveStream\": {\n \"destination\": \"\",\n \"rtmpUrl\": \"\",\n \"streamUrl\": \"\",\n \"layoutWithoutSharedContent\": \"grid\",\n \"layoutWithSharedContent\": \"stack\",\n \"allowChangeLayoutInMeeting\": \"\",\n \"followStageLayoutWhenSynced\": \"\",\n \"resolution\": \"\"\n }\n}" }, "header": [ + { + "description": "Email of the user whose meetings will be patched. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes" + "group", + "meetings", + ":meetingId" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + "query": [ + { + "description": "Person ID of the user whose meeting will be patched. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/meetings/:meetingId?personId=", + "variable": [ + { + "description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.", + "key": "meetingId", + "value": "" + } + ] } }, - "status": "Method Not Allowed" + "status": "Locked (WebDAV) (RFC 4918)" } ] }, { - "name": "Get a Tracking Code", + "name": "Update Group Meeting Control Status", "request": { - "description": "Retrieves details for a tracking code by an admin user.\n\n* If `siteUrl` is specified, the tracking code is retrieved from the specified site; otherwise, the tracking code is retrieved from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub, this is a one-time irreversible operation. Once the tracking codes are mapped to custom or user profile attributes, the response returns details for a mapped tracking code.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, + "description": "Update meeting recording control status by a service app which has group meeting access. The service app can use this API to start, stop, pause, or resume meeting recording by providing an `action` value. The `personId` parameter or `hostEmail` header of the person to whom the meeting belongs must be specified. The service app which invokes the API manages one or more groups, and it also manages one or more sites. The user specified by `hostEmail` or `personId` must be in a group that is managed by the service app. The meeting specified by `meetingId` must be on a site that is managed by the service app. Please note that once the meeting recording has been controlled by a person in the meeting, the recording control of this meeting can no longer be controlled by the service app via the API.", "header": [ { - "key": "Accept", + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId", - "value": "" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 502, "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 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 \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, + "header": [ + { + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, - "status": "Unsupported Media Type" + "status": "Bad Gateway" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, + "header": [ + { + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, - "status": "Bad Gateway" + "status": "Method Not Allowed" }, { "_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 \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, + "header": [ + { + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, - "status": "Internal Server Error" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -77621,33 +78370,45 @@ "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 \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, + "header": [ + { + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, "status": "Locked (WebDAV) (RFC 4918)" @@ -77655,402 +78416,512 @@ { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, + "header": [ + { + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 202, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Accepted: The update request has been accepted for processing.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, + "header": [ + { + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, - "status": "Method Not Allowed" + "status": "Accepted" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, + "header": [ + { + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, - "status": "Too Many Requests" + "status": "Gone" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"text\",\n \"hostProfileCode\": \"required\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"required\"\n },\n {\n \"service\": \"SupportCenter\",\n \"type\": \"notApplicable\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 409, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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 \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, "header": [ { - "key": "Accept", + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, - "status": "OK" + "status": "Conflict" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, + "header": [ + { + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, - "status": "Conflict" + "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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, + "header": [ + { + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, - "status": "Gateway Timeout" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 400, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "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 \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, + "header": [ + { + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, - "status": "Gone" + "status": "Bad Request" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, + "header": [ + { + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, - "status": "Precondition Required" + "status": "Too Many Requests" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, + "header": [ + { + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, + "header": [ + { + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -78060,33 +78931,45 @@ "header": [], "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 \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, + "header": [ + { + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, "status": "Service Unavailable" @@ -78097,66 +78980,69 @@ "code": 404, "cookie": [], "header": [], - "name": "Not Found", + "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 \"meetingId\": \"\",\n \"action\": \"pauseRecording\"\n}" + }, + "header": [ + { + "description": "Email of the user whose meeting control will be updated. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" + "group", + "meetings", + "controls" ], "query": [ { - "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "description": "Person ID of the user whose meeting control will be updated. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code whose details are being requested.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/group/meetings/controls?personId=" } }, "status": "Not Found" } ] - }, + } + ], + "name": "Meetings" + }, + { + "item": [ { - "name": "Update a Tracking Code", + "name": "List Tracking Codes", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" - }, - "description": "Updates details for a tracking code by an admin user.\n\n* The `siteUrl` is required. The operation updates a tracking code for the specified site. All of a user's available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* The `inputMode` of `hostProfileSelect` is only available for the host profile and sign-up pages and it doesn't apply to the meeting scheduler page or meeting start page. Therefore, `scheduleStartCodes` must be `null` or type of all services must be `notUsed` when the `inputMode` is `hostProfileSelect`.\n\n* Currently, the `hostProfileCode` of `required` is only allowed for a Site Admin managed site, and not allowed for a Control Hub managed site.\n\n* When the `hostProfileCode` is `adminSet`, only `adminSet`, `notUsed` and `notApplicable` are available for the types of `scheduleStartCodes`. When the `hostProfileCode` is not `adminSet`, only `optional`, `required`, `notUsed` and `notApplicable` are available for types of `scheduleStartCodes`.\n\n* If the type of the `All` service has a value other than `notApplicable`, and another service, e.g. `EventCenter`, is missing from the `scheduleStartCodes`, then the type of this missing `EventCenter` service shares the same type as the `All` service silently. If the type of `All` service has a value other than `notApplicable`, and another service, e.g. `EventCenter`, has a type, then the type specified should be the same as the `All` service.\n\n* If the `All` service is missing from the `scheduleStartCodes`, any of the other four services, e.g. `EventCenter`, has a default type of `notUsed` if that service is also missing from the `scheduleStartCodes`.\n\n* Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub, this is a one-time irreversible operation. Once the tracking codes are mapped to custom or user profile attributes, they cannot update tracking codes when the mapping process is in progress or the mapping process is completed.", + "description": "Lists tracking codes on a site by an admin user.\n\n* If `siteUrl` is specified, tracking codes of the specified site will be listed; otherwise, tracking codes of the user's preferred site will be listed. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub. This is a one-time irreversible operation. Once the tracking codes are mapped to custom or user profile attributes, the response returns the mapped tracking codes.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78165,43 +79051,29 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId", - "variable": [ + "query": [ { - "key": "trackingCodeId" + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" } }, "response": [ { "_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 \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78210,39 +79082,30 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" } }, - "status": "Service Unavailable" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78251,48 +79114,30 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" } }, - "status": "Bad Gateway" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"text\",\n \"hostProfileCode\": \"required\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"required\"\n },\n {\n \"service\": \"SupportCenter\",\n \"type\": \"notApplicable\"\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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78301,39 +79146,30 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" } }, - "status": "OK" + "status": "Bad Gateway" }, { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78342,39 +79178,30 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" } }, - "status": "Forbidden" + "status": "Precondition Required" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78383,39 +79210,30 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" } }, - "status": "Too Many Requests" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 400, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "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 \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78424,39 +79242,30 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" } }, - "status": "Precondition Required" + "status": "Bad Request" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78465,39 +79274,30 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 401, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78506,39 +79306,30 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" } }, - "status": "Method Not Allowed" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 500, "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": "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 \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78547,39 +79338,40 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" } }, - "status": "Not Found" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 415, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"required\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"adminSet\"\n },\n {\n \"service\": \"EventCenter\",\n \"type\": \"adminSet\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"text\",\n \"hostProfileCode\": \"optional\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"optional\"\n },\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"optional\"\n }\n ]\n }\n ]\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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" - }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -78588,21 +79380,260 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" } }, - "status": "Unsupported Media Type" + "status": "OK" }, { "_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", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "config", + "trackingCodes" + ], + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + } + }, + "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": [ + "admin", + "meeting", + "config", + "trackingCodes" + ], + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "config", + "trackingCodes" + ], + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + } + }, + "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": [ + "admin", + "meeting", + "config", + "trackingCodes" + ], + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + } + }, + "status": "Gateway Timeout" + }, + { + "_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": [ + "admin", + "meeting", + "config", + "trackingCodes" + ], + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "config", + "trackingCodes" + ], + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes?siteUrl=" + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Create a Tracking Code", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, + "description": "Create a new tracking code by an admin user.\n\n* The `siteUrl` is required. The operation creates a tracking code for the specified site. All or a user's available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* The `inputMode` of `hostProfileSelect` is only available for a host profile and sign-up pages and does not apply to the meeting scheduler page or the meeting start page. The value for `scheduleStartCodes` must be `null` or the value for all services must be `notUsed` when the `inputMode` is `hostProfileSelect`.\n\n* The `hostProfileCode` of `required` is only allowed for a Site Admin managed site, and not for a Control Hub managed site.\n\n* When the `hostProfileCode` is `adminSet`, only `adminSet`, `notUsed`, and `notApplicable` are available for the types of `scheduleStartCodes`. When the `hostProfileCode` is not `adminSet`, only `optional`, `required`, `notUsed`, and `notApplicable` are available for `scheduleStartCodes`.\n\n* If the type of the `All` service has a value other than `notApplicable`, and another service, e.g. `EventCenter`, is missing from the `scheduleStartCodes`, then the type of this missing `EventCenter` service shares the same type as the `All` service. If the type of `All` service has a value other than `notApplicable`, and another service, e.g. `EventCenter`, has a type, then the type specified should be the same as the `All` service.\n\n* If the `All` service is missing from the `scheduleStartCodes`, any of the other four services, e.g. `EventCenter`, have a default type of `notUsed` if it is also missing from the `scheduleStartCodes`.\n\n* Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub, this is a one-time irreversible operation. Once the tracking codes are mapped to custom or user profile attributes, they cannot create tracking codes when the mapping process is in progress or the mapping process is completed.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "config", + "trackingCodes" + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + } + }, + "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", @@ -78620,7 +79651,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -78629,26 +79660,20 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" } }, - "status": "Unauthorized" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": null, + "code": 404, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Bad Request", + "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", @@ -78664,13 +79689,9 @@ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -78679,21 +79700,20 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" } }, - "status": "Bad Request" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 410, "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": "Gone: The requested resource is no longer available.", "originalRequest": { "body": { "mode": "raw", @@ -78711,7 +79731,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -78720,21 +79740,20 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" } }, - "status": "Gateway Timeout" + "status": "Gone" }, { "_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": { "body": { "mode": "raw", @@ -78752,7 +79771,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -78761,21 +79780,20 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 415, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "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", @@ -78793,7 +79811,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -78802,13 +79820,12 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" } }, - "status": "Gone" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", @@ -78834,7 +79851,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -78843,51 +79860,13 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" } }, "status": "Conflict" - } - ] - }, - { - "name": "Delete a Tracking Code", - "request": { - "description": "Deletes a tracking code by an admin user.\n\n* The `siteUrl` is required. The operation deletes a tracking code for the specified site. All of a user's available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub, this is a one-time irreversible operation. Once the tracking codes are mapped to custom or user profile attributes, they cannot delete tracking codes when the mapping process is in progress or the mapping process is completed.", - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "meeting", - "config", - "trackingCodes", - ":trackingCodeId" - ], - "query": [ - { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code to be deleted.", - "key": "trackingCodeId", - "value": "" - } - ] - } - }, - "response": [ + }, { "_postman_previewlanguage": "text", "body": null, @@ -78896,8 +79875,23 @@ "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -78906,23 +79900,9 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" - ], - "query": [ - { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - } + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code to be deleted.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" } }, "status": "Internal Server Error" @@ -78930,13 +79910,28 @@ { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -78945,37 +79940,38 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" - ], - "query": [ - { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - } + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code to be deleted.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" } }, - "status": "Method Not Allowed" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 428, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "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 \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -78984,37 +79980,38 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" - ], - "query": [ - { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - } + "trackingCodes" ], - "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", - "variable": [ - { - "description": "Unique identifier for the tracking code to be deleted.", - "key": "trackingCodeId" - } - ] + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" } }, - "status": "Bad Gateway" + "status": "Precondition Required" }, { "_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": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -79023,37 +80020,362 @@ "admin", "meeting", "config", - "trackingCodes", - ":trackingCodeId" + "trackingCodes" ], - "query": [ - { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + } + }, + "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 \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "config", + "trackingCodes" + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + } + }, + "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 \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "config", + "trackingCodes" + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json;charset=UTF-8" + } + ], + "name": "Bad Request", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "config", + "trackingCodes" + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "config", + "trackingCodes" + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"text\",\n \"hostProfileCode\": \"required\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"required\"\n },\n {\n \"service\": \"SupportCenter\",\n \"type\": \"notApplicable\"\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 \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "config", + "trackingCodes" + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + } + }, + "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 \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "config", + "trackingCodes" + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes" + } + }, + "status": "Method Not Allowed" + } + ] + }, + { + "name": "Get a Tracking Code", + "request": { + "description": "Retrieves details for a tracking code by an admin user.\n\n* If `siteUrl` is specified, the tracking code is retrieved from the specified site; otherwise, the tracking code is retrieved from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub, this is a one-time irreversible operation. Once the tracking codes are mapped to custom or user profile attributes, the response returns details for a mapped tracking code.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "config", + "trackingCodes", + ":trackingCodeId" + ], + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code whose details are being requested.", + "key": "trackingCodeId", + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "config", + "trackingCodes", + ":trackingCodeId" + ], + "query": [ + { + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" } ], "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", "variable": [ { - "description": "Unique identifier for the tracking code to be deleted.", + "description": "Unique identifier for the tracking code whose details are being requested.", "key": "trackingCodeId" } ] } }, - "status": "Gateway Timeout" + "status": "Unsupported Media Type" }, { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -79067,7 +80389,7 @@ ], "query": [ { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" } @@ -79075,24 +80397,24 @@ "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", "variable": [ { - "description": "Unique identifier for the tracking code to be deleted.", + "description": "Unique identifier for the tracking code whose details are being requested.", "key": "trackingCodeId" } ] } }, - "status": "Unauthorized" + "status": "Bad Gateway" }, { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -79106,7 +80428,7 @@ ], "query": [ { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" } @@ -79114,24 +80436,24 @@ "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", "variable": [ { - "description": "Unique identifier for the tracking code to be deleted.", + "description": "Unique identifier for the tracking code whose details are being requested.", "key": "trackingCodeId" } ] } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 423, "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": "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}}" @@ -79145,7 +80467,7 @@ ], "query": [ { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" } @@ -79153,24 +80475,24 @@ "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", "variable": [ { - "description": "Unique identifier for the tracking code to be deleted.", + "description": "Unique identifier for the tracking code whose details are being requested.", "key": "trackingCodeId" } ] } }, - "status": "Unsupported Media Type" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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}}" @@ -79184,7 +80506,7 @@ ], "query": [ { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" } @@ -79192,24 +80514,24 @@ "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", "variable": [ { - "description": "Unique identifier for the tracking code to be deleted.", + "description": "Unique identifier for the tracking code whose details are being requested.", "key": "trackingCodeId" } ] } }, - "status": "Bad Request" + "status": "Unauthorized" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -79223,7 +80545,7 @@ ], "query": [ { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" } @@ -79231,13 +80553,13 @@ "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", "variable": [ { - "description": "Unique identifier for the tracking code to be deleted.", + "description": "Unique identifier for the tracking code whose details are being requested.", "key": "trackingCodeId" } ] } }, - "status": "Conflict" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", @@ -79248,7 +80570,7 @@ "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}}" @@ -79262,7 +80584,7 @@ ], "query": [ { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" } @@ -79270,7 +80592,7 @@ "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", "variable": [ { - "description": "Unique identifier for the tracking code to be deleted.", + "description": "Unique identifier for the tracking code whose details are being requested.", "key": "trackingCodeId" } ] @@ -79279,15 +80601,25 @@ "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 404, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"text\",\n \"hostProfileCode\": \"required\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"required\"\n },\n {\n \"service\": \"SupportCenter\",\n \"type\": \"notApplicable\"\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}}" @@ -79301,7 +80633,7 @@ ], "query": [ { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" } @@ -79309,24 +80641,24 @@ "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", "variable": [ { - "description": "Unique identifier for the tracking code to be deleted.", + "description": "Unique identifier for the tracking code whose details are being requested.", "key": "trackingCodeId" } ] } }, - "status": "Not Found" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 409, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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}}" @@ -79340,7 +80672,7 @@ ], "query": [ { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" } @@ -79348,24 +80680,24 @@ "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", "variable": [ { - "description": "Unique identifier for the tracking code to be deleted.", + "description": "Unique identifier for the tracking code whose details are being requested.", "key": "trackingCodeId" } ] } }, - "status": "Forbidden" + "status": "Conflict" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -79379,7 +80711,7 @@ ], "query": [ { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" } @@ -79387,13 +80719,13 @@ "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", "variable": [ { - "description": "Unique identifier for the tracking code to be deleted.", + "description": "Unique identifier for the tracking code whose details are being requested.", "key": "trackingCodeId" } ] } }, - "status": "Precondition Required" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -79404,7 +80736,7 @@ "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -79418,7 +80750,7 @@ ], "query": [ { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" } @@ -79426,7 +80758,7 @@ "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", "variable": [ { - "description": "Unique identifier for the tracking code to be deleted.", + "description": "Unique identifier for the tracking code whose details are being requested.", "key": "trackingCodeId" } ] @@ -79437,13 +80769,13 @@ { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -79457,7 +80789,7 @@ ], "query": [ { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" } @@ -79465,24 +80797,24 @@ "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", "variable": [ { - "description": "Unique identifier for the tracking code to be deleted.", + "description": "Unique identifier for the tracking code whose details are being requested.", "key": "trackingCodeId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Precondition Required" }, { "_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}}" @@ -79496,7 +80828,7 @@ ], "query": [ { - "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" } @@ -79504,73 +80836,23 @@ "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", "variable": [ { - "description": "Unique identifier for the tracking code to be deleted.", + "description": "Unique identifier for the tracking code whose details are being requested.", "key": "trackingCodeId" } ] } }, - "status": "No Content" - } - ] - }, - { - "name": "Get User Tracking Codes", - "request": { - "description": "Lists user's tracking codes by an admin user.\n\n* At least one parameter, either `personId`, or `email` is required. `personId` must come before `email` if both are specified. Please note that `email` is specified in the request header.\n\n* If `siteUrl` is specified, the tracking codes of the specified site will be listed; otherwise, the tracking codes of a user's preferred site are listed. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API. Please note that the user here is the admin user who invokes the API, not the user specified by `personId` or email.\n\n* Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub, this is a one-time irreversible operation. Once the tracking codes are mapped to custom or user profile attributes, the response returns the user's mapped tracking codes.\n\n#### Request Header\n\n* `email`: Email address for the user whose tracking codes are being retrieved. The admin users can specify the email of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "header": [ - { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "meeting", - "userconfig", - "trackingCodes" - ], - "query": [ - { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" - } - }, - "response": [ + "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": { - "header": [ - { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -79579,41 +80861,37 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], "query": [ { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code whose details are being requested.", + "key": "trackingCodeId" + } + ] } }, - "status": "Method Not Allowed" + "status": "Forbidden" }, { "_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": { - "header": [ - { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -79622,41 +80900,37 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], "query": [ { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code whose details are being requested.", + "key": "trackingCodeId" + } + ] } }, - "status": "Bad Gateway" + "status": "Service Unavailable" }, { "_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", "originalRequest": { - "header": [ - { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -79665,42 +80939,100 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], "query": [ { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" } ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code whose details are being requested.", + "key": "trackingCodeId" + } + ] } }, - "status": "Precondition Required" + "status": "Not Found" + } + ] + }, + { + "name": "Update a Tracking Code", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" }, + "description": "Updates details for a tracking code by an admin user.\n\n* The `siteUrl` is required. The operation updates a tracking code for the specified site. All of a user's available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* The `inputMode` of `hostProfileSelect` is only available for the host profile and sign-up pages and it doesn't apply to the meeting scheduler page or meeting start page. Therefore, `scheduleStartCodes` must be `null` or type of all services must be `notUsed` when the `inputMode` is `hostProfileSelect`.\n\n* Currently, the `hostProfileCode` of `required` is only allowed for a Site Admin managed site, and not allowed for a Control Hub managed site.\n\n* When the `hostProfileCode` is `adminSet`, only `adminSet`, `notUsed` and `notApplicable` are available for the types of `scheduleStartCodes`. When the `hostProfileCode` is not `adminSet`, only `optional`, `required`, `notUsed` and `notApplicable` are available for types of `scheduleStartCodes`.\n\n* If the type of the `All` service has a value other than `notApplicable`, and another service, e.g. `EventCenter`, is missing from the `scheduleStartCodes`, then the type of this missing `EventCenter` service shares the same type as the `All` service silently. If the type of `All` service has a value other than `notApplicable`, and another service, e.g. `EventCenter`, has a type, then the type specified should be the same as the `All` service.\n\n* If the `All` service is missing from the `scheduleStartCodes`, any of the other four services, e.g. `EventCenter`, has a default type of `notUsed` if that service is also missing from the `scheduleStartCodes`.\n\n* Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub, this is a one-time irreversible operation. Once the tracking codes are mapped to custom or user profile attributes, they cannot update tracking codes when the mapping process is in progress or the mapping process is completed.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "config", + "trackingCodes", + ":trackingCodeId" + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId", + "variable": [ + { + "key": "trackingCodeId" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 503, "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": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, "header": [ { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -79708,42 +81040,40 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" - ], - "query": [ - { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" - } + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" } }, - "status": "Internal Server Error" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 502, "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 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 \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, "header": [ { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -79751,42 +81081,49 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" - ], - "query": [ - { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" - } + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" } }, - "status": "Unsupported Media Type" + "status": "Bad Gateway" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"text\",\n \"hostProfileCode\": \"required\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"required\"\n },\n {\n \"service\": \"SupportCenter\",\n \"type\": \"notApplicable\"\n }\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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, "header": [ { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -79794,42 +81131,40 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" - ], - "query": [ - { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" - } + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" } }, - "status": "Service Unavailable" + "status": "OK" }, { "_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", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, "header": [ { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -79837,42 +81172,40 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" - ], - "query": [ - { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" - } + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" } }, - "status": "Gone" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 429, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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 \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, "header": [ { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -79880,42 +81213,40 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" - ], - "query": [ - { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" - } + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 428, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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 \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, "header": [ { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -79923,42 +81254,40 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" - ], - "query": [ - { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" - } + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" } }, - "status": "Bad Request" + "status": "Precondition Required" }, { "_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 \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, "header": [ { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -79966,42 +81295,40 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" - ], - "query": [ - { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" - } + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" + }, "header": [ { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -80009,111 +81336,14 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "query": [ - { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" - } - }, - "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": [ - { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "meeting", - "userconfig", - "trackingCodes" - ], - "query": [ - { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" - } - }, - "status": "Gateway Timeout" - }, - { - "_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": [ - { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "meeting", - "userconfig", - "trackingCodes" - ], - "query": [ - { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" } }, - "status": "Conflict" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", @@ -80121,186 +81351,7 @@ "code": 404, "cookie": [], "header": [], - "name": "Not Found", - "originalRequest": { - "header": [ - { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "meeting", - "userconfig", - "trackingCodes" - ], - "query": [ - { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" - } - }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", - "originalRequest": { - "header": [ - { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "meeting", - "userconfig", - "trackingCodes" - ], - "query": [ - { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" - } - }, - "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": [ - { - "description": "e.g. john.andersen@example.com", - "key": "email", - "value": "" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "meeting", - "userconfig", - "trackingCodes" - ], - "query": [ - { - "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", - "key": "personId", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" - } - }, - "status": "Forbidden" - } - ] - }, - { - "name": "Update User Tracking Codes", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "description": "Updates tracking codes for a specified user by an admin user.\n\n* The `siteUrl` is required. The operation updates a user's tracking code on the specified site. All a user's available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API. Please note that the user here is the admin user who invokes the API, not the user specified by `personId` or `email`.\n\n* A name that is not found in the site-level tracking codes cannot be set for a user's tracking codes. All available site-level tracking codes for a site can be retrieved by the [List Tracking Codes](/docs/api/v1/tracking-codes/list-tracking-codes) API.\n\n* If the `inputMode` of a user's tracking code is `select` or `hostProfileSelect`, its value must be one of the site-level options of that tracking code. All available site-level tracking codes for a site can be retrieved by the [List Tracking Codes](/docs/api/v1/tracking-codes/list-tracking-codes) API.\n\n* Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub, this is a one-time irreversible operation. Once the tracking codes are mapped to custom or user profile attributes, they cannot update user's tracking codes when the mapping process is in progress or the mapping process is completed.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "meeting", - "userconfig", - "trackingCodes" - ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" - } - }, - "response": [ - { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, - "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": { "body": { "mode": "raw", @@ -80310,7 +81361,7 @@ "language": "json" } }, - "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" }, "header": [ { @@ -80326,26 +81377,22 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" } }, - "status": "Service Unavailable" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 415, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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", @@ -80355,16 +81402,12 @@ "language": "json" } }, - "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], "method": "PUT", @@ -80375,21 +81418,22 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" } }, - "status": "OK" + "status": "Unsupported Media Type" }, { "_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": { "body": { "mode": "raw", @@ -80399,7 +81443,7 @@ "language": "json" } }, - "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" }, "header": [ { @@ -80415,13 +81459,14 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" } }, - "status": "Unsupported Media Type" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -80444,7 +81489,7 @@ "language": "json" } }, - "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" }, "header": [ { @@ -80464,10 +81509,11 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" } }, "status": "Bad Request" @@ -80475,10 +81521,10 @@ { "_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": { "body": { "mode": "raw", @@ -80488,7 +81534,7 @@ "language": "json" } }, - "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" }, "header": [ { @@ -80504,21 +81550,22 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" } }, - "status": "Unauthorized" + "status": "Gateway Timeout" }, { "_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": { "body": { "mode": "raw", @@ -80528,7 +81575,7 @@ "language": "json" } }, - "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" }, "header": [ { @@ -80544,21 +81591,22 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" } }, - "status": "Bad Gateway" + "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", @@ -80568,7 +81616,7 @@ "language": "json" } }, - "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" }, "header": [ { @@ -80584,21 +81632,22 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" } }, - "status": "Too Many Requests" + "status": "Gone" }, { "_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": { "body": { "mode": "raw", @@ -80608,7 +81657,7 @@ "language": "json" } }, - "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"name\": \"\",\n \"siteUrl\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n },\n {\n \"value\": \"\",\n \"defaultValue\": \"\"\n }\n ],\n \"inputMode\": \"editableSelect\",\n \"hostProfileCode\": \"notUsed\",\n \"scheduleStartCodes\": [\n {\n \"service\": \"TrainingCenter\",\n \"type\": \"notUsed\"\n },\n {\n \"service\": \"MeetingCenter\",\n \"type\": \"notUsed\"\n }\n ]\n}" }, "header": [ { @@ -80624,39 +81673,62 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId" } }, - "status": "Gateway Timeout" - }, + "status": "Conflict" + } + ] + }, + { + "name": "Delete a Tracking Code", + "request": { + "description": "Deletes a tracking code by an admin user.\n\n* The `siteUrl` is required. The operation deletes a tracking code for the specified site. All of a user's available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub, this is a one-time irreversible operation. Once the tracking codes are mapped to custom or user profile attributes, they cannot delete tracking codes when the mapping process is in progress or the mapping process is completed.", + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "config", + "trackingCodes", + ":trackingCodeId" + ], + "query": [ + { + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId", + "value": "" + } + ] + } + }, + "response": [ { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -80664,39 +81736,38 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + "query": [ + { + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId" + } + ] } }, - "status": "Method Not Allowed" + "status": "Internal Server Error" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -80704,39 +81775,38 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" - } + "query": [ + { + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId" + } + ] + } }, - "status": "Conflict" + "status": "Method Not Allowed" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -80744,39 +81814,38 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + "query": [ + { + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId" + } + ] } }, - "status": "Forbidden" + "status": "Bad Gateway" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -80784,39 +81853,38 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + "query": [ + { + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -80824,39 +81892,38 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + "query": [ + { + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId" + } + ] } }, - "status": "Precondition Required" + "status": "Unauthorized" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -80864,39 +81931,38 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + "query": [ + { + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId" + } + ] } }, - "status": "Not Found" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 415, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "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 \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -80904,39 +81970,38 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + "query": [ + { + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId" + } + ] } }, - "status": "Gone" + "status": "Unsupported Media Type" }, { "_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 \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -80944,867 +82009,641 @@ "path": [ "admin", "meeting", - "userconfig", - "trackingCodes" + "config", + "trackingCodes", + ":trackingCodeId" ], - "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + "query": [ + { + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId" + } + ] } }, - "status": "Internal Server Error" - } - ] - } - ], - "name": "Tracking Codes" - }, - { - "item": [ - { - "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. 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", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "people" - ], - "query": [ - { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" - } - ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" - } - }, - "response": [ + "status": "Bad Request" + }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "config", + "trackingCodes", + ":trackingCodeId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId" + } + ] } }, - "status": "Too Many Requests" + "status": "Conflict" }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "config", + "trackingCodes", + ":trackingCodeId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId" + } + ] } }, - "status": "Bad Request" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 404, "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": "Not Found", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "config", + "trackingCodes", + ":trackingCodeId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId" + } + ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"mobile\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"fax\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"unknown\",\n \"invitePending\": \"false\",\n \"loginEnabled\": \"false\",\n \"type\": \"bot\"\n },\n {\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"mobile\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"work_extension\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"call\",\n \"invitePending\": \"false\",\n \"loginEnabled\": \"true\",\n \"type\": \"person\"\n }\n ],\n \"notFoundIds\": [\n \"\",\n \"\"\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" - } - ], - "name": "OK", + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "config", + "trackingCodes", + ":trackingCodeId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId" + } + ] } }, - "status": "OK" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 428, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "config", + "trackingCodes", + ":trackingCodeId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId" + } + ] } }, - "status": "Bad Gateway" + "status": "Precondition Required" }, { "_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", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "config", + "trackingCodes", + ":trackingCodeId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId" + } + ] } }, - "status": "Forbidden" + "status": "Gone" }, { "_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": [ - "people" + "admin", + "meeting", + "config", + "trackingCodes", + ":trackingCodeId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ + { + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId" + } + ] } }, - "status": "Gateway Timeout" + "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": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "config", + "trackingCodes", + ":trackingCodeId" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", + "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" - }, + } + ], + "raw": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId?siteUrl=", + "variable": [ { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, + "description": "Unique identifier for the tracking code to be deleted.", + "key": "trackingCodeId" + } + ] + } + }, + "status": "No Content" + } + ] + }, + { + "name": "Get User Tracking Codes", + "request": { + "description": "Lists user's tracking codes by an admin user.\n\n* At least one parameter, either `personId`, or `email` is required. `personId` must come before `email` if both are specified. Please note that `email` is specified in the request header.\n\n* If `siteUrl` is specified, the tracking codes of the specified site will be listed; otherwise, the tracking codes of a user's preferred site are listed. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API. Please note that the user here is the admin user who invokes the API, not the user specified by `personId` or email.\n\n* Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub, this is a one-time irreversible operation. Once the tracking codes are mapped to custom or user profile attributes, the response returns the user's mapped tracking codes.\n\n#### Request Header\n\n* `email`: Email address for the user whose tracking codes are being retrieved. The admin users can specify the email of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "header": [ + { + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "userconfig", + "trackingCodes" + ], + "query": [ + { + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" + } + }, + "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": [ + { + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "userconfig", + "trackingCodes" + ], + "query": [ { - "description": "List of roleIds separated by commas.", - "key": "roles", + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" }, { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" } }, - "status": "Unsupported Media Type" + "status": "Method Not Allowed" }, { "_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": { - "header": [], + "header": [ + { + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" }, { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" } }, - "status": "Conflict" + "status": "Bad Gateway" }, { "_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": [], + "header": [ + { + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" }, { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" } }, - "status": "Method Not Allowed" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 500, "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": "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": [], + "header": [ + { + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" }, { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", "value": "" - }, + } + ], + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" + } + }, + "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": [ + { + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "userconfig", + "trackingCodes" + ], + "query": [ { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" }, { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", "value": "" - }, + } + ], + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [ + { + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "userconfig", + "trackingCodes" + ], + "query": [ { - "description": "List of roleIds separated by commas.", - "key": "roles", + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" }, { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", @@ -81814,63 +82653,37 @@ "header": [], "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], + "header": [ + { + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" }, { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" } }, "status": "Gone" @@ -81883,63 +82696,37 @@ "header": [], "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [], + "header": [ + { + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" }, { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" } }, "status": "Unauthorized" @@ -81947,512 +82734,404 @@ { "_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": [], + "header": [ + { + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" }, { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" } }, - "status": "Not Found" + "status": "Bad Request" }, { "_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": [], + "header": [ + { + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", - "value": "" - }, - { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", - "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" }, { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" } }, - "status": "Precondition Required" + "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": [], + "header": [ + { + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], "query": [ { - "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", - "key": "email", - "value": "" - }, - { - "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", - "key": "displayName", - "value": "" - }, - { - "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", - "key": "id", + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", "value": "" }, { - "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", - "key": "orgId", + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", "value": "" - }, - { - "description": "List of roleIds separated by commas.", - "key": "roles", - "value": "" - }, - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "List people present in this location.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", - "key": "max", - "value": "100" - }, - { - "description": "Omit people status/availability to enhance query performance.", - "key": "excludeStatus", - "value": "false" } ], - "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" - } - }, - "status": "Service Unavailable" - } - ] - }, - { - "name": "Create a Person", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" } }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" + "status": "Locked (WebDAV) (RFC 4918)" }, - "description": "Create a new user account for a given organization. Only an admin can create a new user account.\n\nAt least one of the following body parameters is required to create a new user: `displayName`, `firstName`, `lastName`.\n\nCurrently, users may have only one email address associated with their account. The `emails` parameter is an array, which accepts multiple values to allow for future expansion, but currently only one email address will be used for the new user.\n\nAdmin users can include `Webex calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true. It may happen that the POST request with calling data returns a 400 status, but the person was created still. One way to get into this state is if an invalid phone number is assigned to a user. The people API aggregates calls to several other microservices, and one may have failed. A best practice is to check if the user exists before retrying. This can be done with the user's email address and a GET /people.\n\nWhen doing attendee management, append `#attendee` to the `siteUrl` parameter (e.g. `mysite.webex.com#attendee`) to make the new user an attendee for a site.\n\n**NOTES**:\n\n* For creating a `Webex Calling` user, you must provide `phoneNumbers` or `extension`, `locationId`, and `licenses` string in the same request.\n\n* `SipAddresses` are asigned via an asynchronous process. This means that the POST response may not show the SIPAddresses immediately. Instead you can verify them with a separate GET to /people, after they were newly configured.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "people" - ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" - } - ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" - } - }, - "response": [ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" }, { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" } }, - "status": "Conflict" + "status": "Gateway Timeout" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" }, { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" } }, - "status": "Gone" + "status": "Conflict" }, { "_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", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" }, { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" } }, - "status": "Precondition Required" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 429, + "_postman_previewlanguage": "json", + "body": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, "header": [ { - "key": "Content-Type", + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" + }, + { + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" }, { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" } }, - "status": "Too Many Requests" + "status": "OK" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. john.andersen@example.com", + "key": "email", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], "query": [ { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" + "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" }, { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required.", + "key": "personId", + "value": "" } ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes?siteUrl=&personId=" } }, - "status": "Internal Server Error" + "status": "Forbidden" + } + ] + }, + { + "name": "Update User Tracking Codes", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, + "description": "Updates tracking codes for a specified user by an admin user.\n\n* The `siteUrl` is required. The operation updates a user's tracking code on the specified site. All a user's available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API. Please note that the user here is the admin user who invokes the API, not the user specified by `personId` or `email`.\n\n* A name that is not found in the site-level tracking codes cannot be set for a user's tracking codes. All available site-level tracking codes for a site can be retrieved by the [List Tracking Codes](/docs/api/v1/tracking-codes/list-tracking-codes) API.\n\n* If the `inputMode` of a user's tracking code is `select` or `hostProfileSelect`, its value must be one of the site-level options of that tracking code. All available site-level tracking codes for a site can be retrieved by the [List Tracking Codes](/docs/api/v1/tracking-codes/list-tracking-codes) API.\n\n* Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub, this is a one-time irreversible operation. Once the tracking codes are mapped to custom or user profile attributes, they cannot update user's tracking codes when the mapping process is in progress or the mapping process is completed.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "userconfig", + "trackingCodes" + ], + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + } + }, + "response": [ { "_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": "raw", @@ -82462,7 +83141,7 @@ "language": "json" } }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82470,38 +83149,34 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" - ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" - } + "admin", + "meeting", + "userconfig", + "trackingCodes" ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" } }, - "status": "Unsupported Media Type" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 405, + "_postman_previewlanguage": "json", + "body": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\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": { "body": { "mode": "raw", @@ -82511,46 +83186,41 @@ "language": "json" } }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" - ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" - } + "admin", + "meeting", + "userconfig", + "trackingCodes" ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" } }, - "status": "Method Not Allowed" + "status": "OK" }, { "_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": "raw", @@ -82560,7 +83230,7 @@ "language": "json" } }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82568,35 +83238,26 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" - ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" - } + "admin", + "meeting", + "userconfig", + "trackingCodes" ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" } }, - "status": "Not Found" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"fax\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"unknown\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"appuser\"\n}", - "code": 200, + "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "code": 400, "cookie": [], "header": [ { @@ -82604,7 +83265,7 @@ "value": "application/json" } ], - "name": "OK", + "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", @@ -82614,7 +83275,7 @@ "language": "json" } }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82626,38 +83287,29 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" - ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" - } + "admin", + "meeting", + "userconfig", + "trackingCodes" ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" } }, - "status": "OK" + "status": "Bad Request" }, { "_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": { "body": { "mode": "raw", @@ -82667,7 +83319,7 @@ "language": "json" } }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82675,38 +83327,29 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" - ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" - } + "admin", + "meeting", + "userconfig", + "trackingCodes" ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" } }, - "status": "Service Unavailable" + "status": "Unauthorized" }, { "_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", @@ -82716,7 +83359,7 @@ "language": "json" } }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82724,38 +83367,29 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" - ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" - } + "admin", + "meeting", + "userconfig", + "trackingCodes" ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" } }, - "status": "Unauthorized" + "status": "Bad Gateway" }, { "_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": { "body": { "mode": "raw", @@ -82765,7 +83399,7 @@ "language": "json" } }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82773,38 +83407,29 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" - ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" - } + "admin", + "meeting", + "userconfig", + "trackingCodes" ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" } }, - "status": "Bad Gateway" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 504, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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", @@ -82814,7 +83439,7 @@ "language": "json" } }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82822,38 +83447,69 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + } + }, + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } + }, + "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "path": [ + "admin", + "meeting", + "userconfig", + "trackingCodes" + ], + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" } }, - "status": "Forbidden" + "status": "Method Not Allowed" }, { "_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": { "body": { "mode": "raw", @@ -82863,7 +83519,7 @@ "language": "json" } }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82871,30 +83527,61 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + } + }, + "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 \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "path": [ + "admin", + "meeting", + "userconfig", + "trackingCodes" + ], + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" } }, - "status": "Gateway Timeout" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -82912,7 +83599,7 @@ "language": "json" } }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82920,38 +83607,69 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_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 \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "path": [ + "admin", + "meeting", + "userconfig", + "trackingCodes" + ], + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Precondition Required" }, { "_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", @@ -82961,7 +83679,7 @@ "language": "json" } }, - "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82969,37 +83687,113 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people" + "admin", + "meeting", + "userconfig", + "trackingCodes" ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + } + }, + "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 \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" + "path": [ + "admin", + "meeting", + "userconfig", + "trackingCodes" + ], + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" } }, - "status": "Bad Request" + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"siteUrl\": \"\",\n \"personId\": \"\",\n \"email\": \"\",\n \"trackingCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "meeting", + "userconfig", + "trackingCodes" + ], + "raw": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes" + } + }, + "status": "Internal Server Error" } ] - }, + } + ], + "name": "Tracking Codes" + }, + { + "item": [ { - "name": "Get Person Details", + "name": "List People", "request": { - "description": "Shows details for a person, by ID.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be displayed for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/).\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`.\n\nSpecify the person ID in the `personId` parameter in the URI.", + "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", @@ -83012,34 +83806,66 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId", + "description": "List people present in this location.", + "key": "locationId", "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, "response": [ { "_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", @@ -83048,34 +83874,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Service Unavailable" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 400, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], "method": "GET", @@ -83084,34 +83943,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Gone" + "status": "Bad Request" }, { "_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", @@ -83120,70 +84012,155 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Method Not Allowed" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 415, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"mobile\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"fax\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"enterprise\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"unknown\",\n \"invitePending\": \"false\",\n \"loginEnabled\": \"false\",\n \"type\": \"bot\"\n },\n {\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"mobile\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"work_extension\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"call\",\n \"invitePending\": \"false\",\n \"loginEnabled\": \"true\",\n \"type\": \"person\"\n }\n ],\n \"notFoundIds\": [\n \"\",\n \"\"\n ]\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" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Unsupported Media Type" + "status": "OK" }, { "_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": { "header": [], "method": "GET", @@ -83192,34 +84169,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Unauthorized" + "status": "Bad Gateway" }, { "_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", @@ -83228,34 +84238,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Bad Gateway" + "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", @@ -83264,34 +84307,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_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": { "header": [], "method": "GET", @@ -83300,80 +84376,136 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Forbidden" + "status": "Unsupported Media Type" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"fax\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"unknown\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"appuser\"\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 409, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "OK" + "status": "Conflict" }, { "_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": { "header": [], "method": "GET", @@ -83382,34 +84514,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Precondition Required" + "status": "Method Not Allowed" }, { "_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": "GET", @@ -83418,34 +84583,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Internal Server Error" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 410, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -83454,34 +84652,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Bad Request" + "status": "Gone" }, { "_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", @@ -83490,34 +84721,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Too Many Requests" + "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": "GET", @@ -83526,34 +84790,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Conflict" + "status": "Not Found" }, { "_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": { "header": [], "method": "GET", @@ -83562,34 +84859,67 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Not Found" + "status": "Precondition Required" }, { "_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", @@ -83598,31 +84928,64 @@ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ + { + "description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.", + "key": "email", + "value": "" + }, + { + "description": "List people whose name starts with this string. For non-admin requests, either this or email are required.", + "key": "displayName", + "value": "" + }, + { + "description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.", + "key": "id", + "value": "" + }, + { + "description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.", + "key": "orgId", + "value": "" + }, + { + "description": "List of roleIds separated by commas.", + "key": "roles", + "value": "" + }, { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false", - "variable": [ + }, { - "description": "A unique identifier for the person.", - "key": "personId" + "description": "List people present in this location.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.", + "key": "max", + "value": "100" + }, + { + "description": "Omit people status/availability to enhance query performance.", + "key": "excludeStatus", + "value": "false" } - ] + ], + "raw": "{{baseUrl}}/people?email=&displayName=&id=&orgId=&roles=&callingData=false&locationId=&max=100&excludeStatus=false" } }, - "status": "Gateway Timeout" + "status": "Service Unavailable" } ] }, { - "name": "Update a Person", + "name": "Create a Person", "request": { "body": { "mode": "raw", @@ -83632,9 +84995,9 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, - "description": "Update details for a person, by ID.\n\nSpecify the person ID in the `personId` parameter in the URI. Only an admin can update a person details.\n\nInclude all details for the person. This action expects all user details to be present in the request. A common approach is to first [GET the person's details](/docs/api/v1/people/get-person-details), make changes, then PUT both the changed and unchanged values.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.\n\nWhen doing attendee management, to update a user from host role to an attendee for a site append `#attendee` to the respective `siteUrl` and remove the meeting host license for this site from the license array.\nTo update a person from an attendee role to a host for a site, add the meeting license for this site in the meeting array, and remove that site from the `siteurl` parameter.\n\nTo remove the attendee privilege for a user on a meeting site, remove the `sitename#attendee` from the `siteUrl`s array. The `showAllTypes` parameter must be set to `true`.\n\n**NOTE**:\n\n* The `locationId` can only be set when assigning a calling license to a user. It cannot be changed if a user is already an existing calling user.\n\n* The `extension` field should be used to update the Webex Calling extension for a person. The extension value should not include the location routing prefix. The `work_extension` type in the `phoneNumbers` object as seen in the response payload of [List People](/docs/api/v1/people/list-people) or [Get Person Details](/docs/api/v1/people/get-person-details), cannot be used to set the Webex Calling extension for a person.\n\n* When updating a user with multiple email addresses using a PUT request, ensure that the primary email address is listed first in the array. Note that the order of email addresses returned by a GET request is not guaranteed..\n\n* The People API is a combination of several microservices, each responsible for specific attributes of a person. As a result, a PUT request that returns an error response code may still have altered some values of the person's data. Therefore, it is recommended to perform a GET request after encountering an error to verify the current state of the resource. \n\n* Some licenses are implicitly assigned by the system and cannot be admin controlled. They are necessary for the baseline function of the Webex system. If you get an error about implicitly assigned licensed that cannot be removed, please ensure you have the corresponding license in your PUT request.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.", + "description": "Create a new user account for a given organization. Only an admin can create a new user account.\n\nAt least one of the following body parameters is required to create a new user: `displayName`, `firstName`, `lastName`.\n\nCurrently, users may have only one email address associated with their account. The `emails` parameter is an array, which accepts multiple values to allow for future expansion, but currently only one email address will be used for the new user.\n\nAdmin users can include `Webex calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true. It may happen that the POST request with calling data returns a 400 status, but the person was created still. One way to get into this state is if an invalid phone number is assigned to a user. The people API aggregates calls to several other microservices, and one may have failed. A best practice is to check if the user exists before retrying. This can be done with the user's email address and a GET /people.\n\nWhen doing attendee management, append `#attendee` to the `siteUrl` parameter (e.g. `mysite.webex.com#attendee`) to make the new user an attendee for a site.\n\n**NOTES**:\n\n* For creating a `Webex Calling` user, you must provide `phoneNumbers` or `extension`, `locationId`, and `licenses` string in the same request.\n\n* `SipAddresses` are asigned via an asynchronous process. This means that the POST response may not show the SIPAddresses immediately. Instead you can verify them with a separate GET to /people, after they were newly configured.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.", "header": [ { "key": "Content-Type", @@ -83645,14 +85008,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -83661,39 +85023,22 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId", - "value": "" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"fax\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"unknown\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"appuser\"\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 409, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "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", @@ -83703,26 +85048,21 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -83731,34 +85071,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "OK" + "status": "Conflict" }, { "_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", @@ -83768,7 +85097,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -83776,14 +85105,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -83792,34 +85120,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Method Not Allowed" + "status": "Gone" }, { "_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": "raw", @@ -83829,7 +85146,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -83837,14 +85154,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -83853,34 +85169,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Forbidden" + "status": "Precondition Required" }, { "_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": { "body": { "mode": "raw", @@ -83890,7 +85195,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -83898,14 +85203,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -83914,34 +85218,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Unsupported Media Type" + "status": "Too Many Requests" }, { "_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", @@ -83951,7 +85244,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -83959,14 +85252,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -83975,34 +85267,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_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": "raw", @@ -84012,7 +85293,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -84020,14 +85301,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -84036,34 +85316,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Not Found" + "status": "Unsupported Media Type" }, { "_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", @@ -84073,7 +85342,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -84081,14 +85350,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -84097,34 +85365,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Internal Server Error" + "status": "Method Not Allowed" }, { "_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": { "body": { "mode": "raw", @@ -84134,7 +85391,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -84142,14 +85399,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -84158,34 +85414,28 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Conflict" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 428, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"fax\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"unknown\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"appuser\"\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": { "body": { "mode": "raw", @@ -84195,83 +85445,25 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "people", - ":personId" - ], - "query": [ - { - "description": "Include Webex Calling user details in the response.", - "key": "callingData", - "value": "false" - }, - { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", - "key": "minResponse", - "value": "false" - } - ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] - } - }, - "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 \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" - }, - "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -84280,34 +85472,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Too Many Requests" + "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": { "body": { "mode": "raw", @@ -84317,7 +85498,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -84325,14 +85506,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -84341,34 +85521,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Bad Request" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 401, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "body": { "mode": "raw", @@ -84378,7 +85547,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -84386,14 +85555,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -84402,34 +85570,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Gone" + "status": "Unauthorized" }, { "_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", @@ -84439,7 +85596,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -84447,14 +85604,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -84463,34 +85619,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Gateway" }, { "_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": { "body": { "mode": "raw", @@ -84500,7 +85645,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -84508,14 +85653,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -84524,34 +85668,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Gateway Timeout" + "status": "Forbidden" }, { "_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": { "body": { "mode": "raw", @@ -84561,7 +85694,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -84569,14 +85702,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -84585,34 +85717,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Service Unavailable" + "status": "Gateway Timeout" }, { "_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", @@ -84622,7 +85743,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -84630,14 +85751,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -84646,34 +85766,23 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "No Content" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { "body": { "mode": "raw", @@ -84683,7 +85792,7 @@ "language": "json" } }, - "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + "raw": "{\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -84691,14 +85800,13 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "people", - ":personId" + "people" ], "query": [ { @@ -84707,35 +85815,29 @@ "value": "false" }, { - "description": "Include additional user data like `#attendee` role.", - "key": "showAllTypes", - "value": "" - }, - { - "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.", "key": "minResponse", "value": "false" } ], - "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", - "variable": [ - { - "description": "A unique identifier for the person.", - "key": "personId" - } - ] + "raw": "{{baseUrl}}/people?callingData=false&minResponse=false" } }, - "status": "Bad Gateway" + "status": "Bad Request" } ] }, { - "name": "Delete a Person", + "name": "Get Person Details", "request": { - "description": "Remove a person from the system.\n\n**Required Administrator Roles:**\n\nThe following administrators have permission to use this API:\n\n**Customer Organization:**\n- Full administrator\n- User administrator\n\n**Partner/External Access:**\n- External full administrator\n\n**Note:** External read-only administrators, provisioning administrators, and device administrators cannot delete users.\n\nSpecify the person ID in the `personId` parameter in the URI.", - "header": [], - "method": "DELETE", + "description": "Shows details for a person, by ID.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be displayed for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/).\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`.\n\nSpecify the person ID in the `personId` parameter in the URI.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -84744,7 +85846,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -84758,13 +85867,13 @@ { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -84773,7 +85882,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -84782,7 +85898,7 @@ ] } }, - "status": "Method Not Allowed" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", @@ -84793,7 +85909,7 @@ "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -84802,7 +85918,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -84816,13 +85939,13 @@ { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -84831,7 +85954,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -84840,18 +85970,18 @@ ] } }, - "status": "Not Found" + "status": "Method Not Allowed" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -84860,7 +85990,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -84869,7 +86006,7 @@ ] } }, - "status": "Gateway Timeout" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", @@ -84880,7 +86017,7 @@ "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -84889,7 +86026,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -84903,13 +86047,13 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 502, "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": "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}}" @@ -84918,7 +86062,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -84927,18 +86078,18 @@ ] } }, - "status": "Too Many Requests" + "status": "Bad Gateway" }, { "_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": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -84947,7 +86098,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -84956,7 +86114,7 @@ ] } }, - "status": "No Content" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", @@ -84967,7 +86125,7 @@ "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}}" @@ -84976,7 +86134,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -84988,15 +86153,25 @@ "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 415, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"fax\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"unknown\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"appuser\"\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", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -85005,7 +86180,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -85014,7 +86196,7 @@ ] } }, - "status": "Unsupported Media Type" + "status": "OK" }, { "_postman_previewlanguage": "text", @@ -85025,7 +86207,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}}" @@ -85034,7 +86216,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -85048,13 +86237,13 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 500, "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": "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}}" @@ -85063,7 +86252,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -85072,18 +86268,18 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 400, "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 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}}" @@ -85092,7 +86288,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -85101,18 +86304,18 @@ ] } }, - "status": "Conflict" + "status": "Bad Request" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -85121,7 +86324,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -85130,18 +86340,18 @@ ] } }, - "status": "Bad Request" + "status": "Too Many Requests" }, { "_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", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -85150,7 +86360,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -85159,18 +86376,18 @@ ] } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_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": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -85179,7 +86396,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -85188,18 +86412,18 @@ ] } }, - "status": "Service Unavailable" + "status": "Not Found" }, { "_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}}" @@ -85208,7 +86432,14 @@ "people", ":personId" ], - "raw": "{{baseUrl}}/people/:personId", + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false", "variable": [ { "description": "A unique identifier for the person.", @@ -85217,249 +86448,567 @@ ] } }, - "status": "Bad Gateway" + "status": "Gateway Timeout" } ] }, { - "name": "Get My Own Details", + "name": "Update a Person", "request": { - "description": "Get profile details for the authenticated user. This is the same as GET `/people/{personId}` using the Person ID associated with your Auth token.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "description": "Update details for a person, by ID.\n\nSpecify the person ID in the `personId` parameter in the URI. Only an admin can update a person details.\n\nInclude all details for the person. This action expects all user details to be present in the request. A common approach is to first [GET the person's details](/docs/api/v1/people/get-person-details), make changes, then PUT both the changed and unchanged values.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.\n\nWhen doing attendee management, to update a user from host role to an attendee for a site append `#attendee` to the respective `siteUrl` and remove the meeting host license for this site from the license array.\nTo update a person from an attendee role to a host for a site, add the meeting license for this site in the meeting array, and remove that site from the `siteurl` parameter.\n\nTo remove the attendee privilege for a user on a meeting site, remove the `sitename#attendee` from the `siteUrl`s array. The `showAllTypes` parameter must be set to `true`.\n\n**NOTE**:\n\n* When assigning a Webex Calling license, either a telephone number or extension must already be assigned to the person or provided in the request payload.\n\n* When `callingData` is set to `true`, a Webex Calling license must be included in the `licenses` array.\n\n* The `locationId` can only be set when assigning a calling license to a user. It cannot be changed if a user is already an existing calling user.\n\n* The `extension` field should be used to update the Webex Calling extension for a person. The extension value should not include the location routing prefix. The `work_extension` type in the `phoneNumbers` object as seen in the response payload of [List People](/docs/api/v1/people/list-people) or [Get Person Details](/docs/api/v1/people/get-person-details), cannot be used to set the Webex Calling extension for a person.\n\n* When updating a user with multiple email addresses using a PUT request, ensure that the primary email address is listed first in the array. Note that the order of email addresses returned by a GET request is not guaranteed..\n\n* The People API is a combination of several microservices, each responsible for specific attributes of a person. As a result, a PUT request that returns an error response code may still have altered some values of the person's data. Therefore, it is recommended to perform a GET request after encountering an error to verify the current state of the resource. \n\n* Some licenses are implicitly assigned by the system and cannot be admin controlled. They are necessary for the baseline function of the Webex system. If you get an error about implicitly assigned licensed that cannot be removed, please ensure you have the corresponding license in your PUT request.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId", + "value": "" + } + ] } }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"fax\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"unknown\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"appuser\"\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 \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Service Unavailable" + "status": "OK" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Gone" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 403, "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": "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 \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_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 \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Gateway Timeout" + "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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Bad Request" + "status": "Not Found" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" - } - ], - "raw": "{{baseUrl}}/people/me?callingData=false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Bad Gateway" + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "people", + ":personId" + ], + "query": [ + { + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] + } + }, + "status": "Conflict" }, { "_postman_previewlanguage": "text", @@ -85469,24 +87018,55 @@ "header": [], "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 \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, "status": "Precondition Required" @@ -85494,444 +87074,604 @@ { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_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": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Method Not Allowed" + "status": "Bad Request" }, { "_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", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Unauthorized" + "status": "Gone" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"fax\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"unknown\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"appuser\"\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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "OK" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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 \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Internal Server Error" + "status": "Gateway Timeout" }, { "_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": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Conflict" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 204, "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": "No Content", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "No Content" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 502, "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 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 \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "people", - "me" + ":personId" ], "query": [ { "description": "Include Webex Calling user details in the response.", "key": "callingData", "value": "false" + }, + { + "description": "Include additional user data like `#attendee` role.", + "key": "showAllTypes", + "value": "" + }, + { + "description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.", + "key": "minResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/people/me?callingData=false" + "raw": "{{baseUrl}}/people/:personId?callingData=false&showAllTypes=&minResponse=false", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Unsupported Media Type" + "status": "Bad Gateway" } ] - } - ], - "name": "People" - }, - { - "item": [ + }, { - "name": "List of Recording Audit Report Summaries", + "name": "Delete a Person", "request": { - "description": "Lists of recording audit report summaries. You can specify a date range and the maximum number of recording audit report summaries to return.\n\nOnly recording audit report summaries of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the recording audit report summaries of the specified site will be listed; otherwise, recording audit report summaries of the user's preferred site will be listed. All available Webex sites and the preferred site of the user can be retrieved by the `Get Site List` API.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" - } - ], - "method": "GET", - "url": { - "host": [ + "description": "Remove a person from the system.\n\n**Required Administrator Roles:**\n\nThe following administrators have permission to use this API:\n\n**Customer Organization:**\n- Full administrator\n- User administrator\n\n**Partner/External Access:**\n- External full administrator\n\n**Note:** External read-only administrators, provisioning administrators, and device administrators cannot delete users.\n\nSpecify the person ID in the `personId` parameter in the URI.", + "header": [], + "method": "DELETE", + "url": { + "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", + "description": "A unique identifier for the person.", + "key": "personId", "value": "" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"recordingId\": \"\",\n \"topic\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"hostEmail\": \"\",\n \"viewCount\": \"\",\n \"downloadCount\": \"\"\n },\n {\n \"recordingId\": \"\",\n \"topic\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"hostEmail\": \"\",\n \"viewCount\": \"\",\n \"downloadCount\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 405, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json;charset=UTF-8" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" - } - ], - "name": "OK", + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "OK" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 410, "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": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } + ] + } + }, + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + "path": [ + "people", + ":personId" + ], + "raw": "{{baseUrl}}/people/:personId", + "variable": [ + { + "description": "A unique identifier for the person.", + "key": "personId" + } + ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "text", @@ -85941,50 +87681,23 @@ "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, "status": "Gateway Timeout" @@ -85992,170 +87705,89 @@ { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Service Unavailable" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 204, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "No Content", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Bad Request" + "status": "No Content" }, { "_postman_previewlanguage": "text", @@ -86165,50 +87797,23 @@ "header": [], "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, "status": "Forbidden" @@ -86221,50 +87826,23 @@ "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, "status": "Unsupported Media Type" @@ -86277,50 +87855,23 @@ "header": [], "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, "status": "Precondition Required" @@ -86333,50 +87884,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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, "status": "Locked (WebDAV) (RFC 4918)" @@ -86384,354 +87908,158 @@ { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "recordingReport", - "accessSummary" - ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" - } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" - } - }, - "status": "Not Found" - }, - { - "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Unauthorized" + "status": "Conflict" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Bad Gateway" + "status": "Bad Request" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Gone" + "status": "Internal Server Error" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Method Not Allowed" + "status": "Service Unavailable" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessSummary" + "people", + ":personId" ], - "query": [ - { - "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "from", - "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." - }, - { - "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", - "key": "hostEmail", - "value": "" - }, + "raw": "{{baseUrl}}/people/:personId", + "variable": [ { - "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", - "key": "siteUrl", - "value": "" + "description": "A unique identifier for the person.", + "key": "personId" } - ], - "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" + ] } }, - "status": "Conflict" + "status": "Bad Gateway" } ] }, { - "name": "Get Recording Audit Report Details", + "name": "Get My Own Details", "request": { - "description": "Retrieves details for a recording audit report with a specified recording ID.\n\nOnly recording audit report details of meetings hosted by or shared with the authenticated user may be retrieved.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", + "description": "Get profile details for the authenticated user. This is the same as GET `/people/{personId}` using the Person ID associated with your Auth token.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.", "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, { "key": "Accept", - "value": "application/json;charset=UTF-8" + "value": "application/json" } ], "method": "GET", @@ -86740,549 +88068,367 @@ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Gone" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 410, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Bad Request" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 429, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Unsupported Media Type" + "status": "Gateway Timeout" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Precondition Required" + "status": "Not Found" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 502, "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": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Too Many Requests" + "status": "Bad Gateway" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Not Found" + "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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Service Unavailable" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 401, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Bad Gateway" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 405, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"fax\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"created\": \"\",\n \"lastModified\": \"\",\n \"timezone\": \"\",\n \"lastActivity\": \"\",\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"sipAddresses\": [\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n },\n {\n \"type\": \"cloud-calling\",\n \"value\": \"\",\n \"primary\": \"\"\n }\n ],\n \"xmppFederationJid\": \"\",\n \"status\": \"unknown\",\n \"invitePending\": \"true\",\n \"loginEnabled\": \"true\",\n \"type\": \"appuser\"\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": [ { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "key": "Accept", + "value": "application/json" } ], "method": "GET", @@ -87291,239 +88437,152 @@ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Method Not Allowed" + "status": "OK" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"recordingId\": \"\",\n \"topic\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"accessTime\": \"\",\n \"viewed\": \"\",\n \"downloaded\": \"\"\n },\n {\n \"recordingId\": \"\",\n \"topic\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"accessTime\": \"\",\n \"viewed\": \"\",\n \"downloaded\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 409, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json;charset=UTF-8" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" - } - ], - "name": "OK", + "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "OK" + "status": "Conflict" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Gateway Timeout" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordingReport", - "accessDetail" + "people", + "me" ], "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" + "description": "Include Webex Calling user details in the response.", + "key": "callingData", + "value": "false" } ], - "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" + "raw": "{{baseUrl}}/people/me?callingData=false" } }, - "status": "Conflict" + "status": "Unsupported Media Type" } ] - }, + } + ], + "name": "People" + }, + { + "item": [ { - "name": "List Meeting Archive Summaries", + "name": "List of Recording Audit Report Summaries", "request": { - "description": "Lists of meeting archive summaries. You can specify a date range and the maximum number of meeting archive summaries to return.\n\nMeeting archive summaries are only available to full administrators, not even the meeting host.\n\nThe list returned is sorted in descending order by the date and time that the archives were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the meeting archive summaries of the specified site will be listed; otherwise, meeting archive summaries of the user's preferred site will be listed. All available Webex sites and the preferred site of the user can be retrieved by the `Get Site List` API.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", + "description": "Lists of recording audit report summaries. You can specify a date range and the maximum number of recording audit report summaries to return.\n\nOnly recording audit report summaries of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the recording audit report summaries of the specified site will be listed; otherwise, recording audit report summaries of the user's preferred site will be listed. All available Webex sites and the preferred site of the user can be retrieved by the `Get Site List` API.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", "header": [ { "description": "e.g. UTC", @@ -87542,47 +88601,70 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 504, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"recordingId\": \"\",\n \"topic\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"hostEmail\": \"\",\n \"viewCount\": \"\",\n \"downloadCount\": \"\"\n },\n {\n \"recordingId\": \"\",\n \"topic\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"hostEmail\": \"\",\n \"viewCount\": \"\",\n \"downloadCount\": \"\"\n }\n ]\n}", + "code": 200, "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;charset=UTF-8" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { "header": [ { "description": "e.g. UTC", "key": "timezone", "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], "method": "GET", @@ -87592,42 +88674,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Gateway Timeout" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 500, "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": "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": [ { @@ -87643,42 +88730,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Not Found" + "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": { "header": [ { @@ -87694,42 +88786,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Unsupported Media Type" + "status": "Gateway Timeout" }, { "_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": [ { @@ -87745,42 +88842,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Service Unavailable" + "status": "Too Many Requests" }, { "_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": { "header": [ { @@ -87796,66 +88898,53 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Conflict" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"archiveId\": \"\",\n \"serviceType\": \"EventCenter\",\n \"title\": \"\",\n \"createTime\": \"\"\n },\n {\n \"archiveId\": \"\",\n \"serviceType\": \"SupportCenter\",\n \"title\": \"\",\n \"createTime\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 400, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json;charset=UTF-8" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" - } - ], - "name": "OK", + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [ { "description": "e.g. UTC", "key": "timezone", "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" } ], "method": "GET", @@ -87865,42 +88954,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "OK" + "status": "Bad Request" }, { "_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": [ { @@ -87916,42 +89010,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 415, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "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": [ { @@ -87967,42 +89066,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Gone" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 428, "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": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [ { @@ -88018,42 +89122,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Internal Server Error" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 423, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "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": [ { @@ -88069,42 +89178,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Method Not Allowed" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { "header": [ { @@ -88120,34 +89234,39 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Bad Gateway" + "status": "Not Found" }, { "_postman_previewlanguage": "text", @@ -88171,31 +89290,36 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, "status": "Unauthorized" @@ -88203,10 +89327,10 @@ { "_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": [ { @@ -88222,42 +89346,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Forbidden" + "status": "Bad Gateway" }, { "_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": [ { @@ -88273,42 +89402,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Precondition Required" + "status": "Gone" }, { "_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": [ { @@ -88324,42 +89458,47 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Method Not Allowed" }, { "_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": [ { @@ -88375,41 +89514,46 @@ ], "path": [ "recordingReport", - "meetingArchiveSummaries" + "accessSummary" ], "query": [ { - "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "from", "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", + "description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" } ], - "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" + "raw": "{{baseUrl}}/recordingReport/accessSummary?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&hostEmail=&siteUrl=" } }, - "status": "Too Many Requests" + "status": "Conflict" } ] }, { - "name": "Get Meeting Archive Details", + "name": "Get Recording Audit Report Details", "request": { - "description": "Retrieves details for a meeting archive report with a specified archive ID, which contains recording metadata.\n\nMeeting archive details are only available to full administrators, not even the meeting host.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", + "description": "Retrieves details for a recording audit report with a specified recording ID.\n\nOnly recording audit report details of meetings hosted by or shared with the authenticated user may be retrieved.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", "header": [ { "description": "e.g. UTC", @@ -88428,27 +89572,36 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId", + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, "response": [ { "_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": { "header": [ { @@ -88464,27 +89617,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Too Many Requests" + "status": "Gone" }, { "_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": [ { @@ -88500,27 +89663,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Gateway Timeout" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 401, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [ { @@ -88536,27 +89709,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Bad Gateway" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 415, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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": [ { @@ -88572,27 +89755,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Bad Request" + "status": "Unsupported Media Type" }, { "_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": { "header": [ { @@ -88608,27 +89801,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Precondition Required" }, { "_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": [ { @@ -88644,27 +89847,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Not Found" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 429, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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": [ { @@ -88680,27 +89893,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Unauthorized" + "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": { "header": [ { @@ -88716,19 +89939,29 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Forbidden" + "status": "Not Found" }, { "_postman_previewlanguage": "text", @@ -88752,16 +89985,26 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, "status": "Internal Server Error" @@ -88788,16 +90031,26 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, "status": "Service Unavailable" @@ -88805,10 +90058,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 502, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [ { @@ -88824,42 +90077,43 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Precondition Required" + "status": "Bad Gateway" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"archiveId\": \"\",\n \"serviceType\": \"SupportCenter\",\n \"title\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"participants\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"joinedTime\": \"\",\n \"leftTime\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"joinedTime\": \"\",\n \"leftTime\": \"\",\n \"email\": \"\"\n }\n ],\n \"chats\": [\n {\n \"type\": \"\",\n \"senderName\": \"\",\n \"chatTime\": \"\",\n \"target\": \"\",\n \"text\": \"\"\n },\n {\n \"type\": \"\",\n \"senderName\": \"\",\n \"chatTime\": \"\",\n \"target\": \"\",\n \"text\": \"\"\n }\n ],\n \"polls\": [\n {\n \"type\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"content\": {\n \"questionCount\": \"\",\n \"userCount\": \"\",\n \"votedUserCount\": \"\",\n \"questions\": [\n {\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"question\": {\n \"choiceCount\": \"\",\n \"type\": \"\",\n \"text\": \"\"\n },\n \"answerSummary\": [\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n },\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n }\n ],\n \"respondents\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"question\": {\n \"choiceCount\": \"\",\n \"type\": \"\",\n \"text\": \"\"\n },\n \"answerSummary\": [\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n },\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n }\n ],\n \"respondents\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n }\n },\n {\n \"type\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"content\": {\n \"questionCount\": \"\",\n \"userCount\": \"\",\n \"votedUserCount\": \"\",\n \"questions\": [\n {\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"question\": {\n \"choiceCount\": \"\",\n \"type\": \"\",\n \"text\": \"\"\n },\n \"answerSummary\": [\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n },\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n }\n ],\n \"respondents\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"question\": {\n \"choiceCount\": \"\",\n \"type\": \"\",\n \"text\": \"\"\n },\n \"answerSummary\": [\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n },\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n }\n ],\n \"respondents\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n }\n }\n ],\n \"qas\": [\n {\n \"priority\": \"\",\n \"type\": \"\",\n \"displayName\": \"\",\n \"questionTime\": \"\",\n \"target\": \"\",\n \"question\": \"\",\n \"answers\": [\n {\n \"responseMode\": \"\",\n \"displayName\": \"\",\n \"correlationId\": \"\",\n \"email\": \"\",\n \"answerTime\": \"\",\n \"text\": \"\"\n },\n {\n \"responseMode\": \"\",\n \"displayName\": \"\",\n \"correlationId\": \"\",\n \"email\": \"\",\n \"answerTime\": \"\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"priority\": \"\",\n \"type\": \"\",\n \"displayName\": \"\",\n \"questionTime\": \"\",\n \"target\": \"\",\n \"question\": \"\",\n \"answers\": [\n {\n \"responseMode\": \"\",\n \"displayName\": \"\",\n \"correlationId\": \"\",\n \"email\": \"\",\n \"answerTime\": \"\",\n \"text\": \"\"\n },\n {\n \"responseMode\": \"\",\n \"displayName\": \"\",\n \"correlationId\": \"\",\n \"email\": \"\",\n \"answerTime\": \"\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"systemInfos\": [\n {\n \"displayName\": \"\",\n \"catalogs\": [\n {\n \"systemSummary\": \"\",\n \"browser\": \"\",\n \"hardware\": \"\",\n \"installedSoftware\": \"\",\n \"runningSoftware\": \"\",\n \"startupPrograms\": \"\",\n \"storage\": \"\",\n \"video\": \"\",\n \"network\": \"\",\n \"operatingSystem\": \"\",\n \"environmentVariables\": \"\",\n \"processes\": \"\",\n \"logicalDrives\": \"\",\n \"devices\": \"\",\n \"services\": \"\",\n \"systemDrivers\": \"\",\n \"signedDrivers\": \"\",\n \"eventViewer\": \"\",\n \"bios\": \"\"\n },\n {\n \"systemSummary\": \"\",\n \"browser\": \"\",\n \"hardware\": \"\",\n \"installedSoftware\": \"\",\n \"runningSoftware\": \"\",\n \"startupPrograms\": \"\",\n \"storage\": \"\",\n \"video\": \"\",\n \"network\": \"\",\n \"operatingSystem\": \"\",\n \"environmentVariables\": \"\",\n \"processes\": \"\",\n \"logicalDrives\": \"\",\n \"devices\": \"\",\n \"services\": \"\",\n \"systemDrivers\": \"\",\n \"signedDrivers\": \"\",\n \"eventViewer\": \"\",\n \"bios\": \"\"\n }\n ]\n },\n {\n \"displayName\": \"\",\n \"catalogs\": [\n {\n \"systemSummary\": \"\",\n \"browser\": \"\",\n \"hardware\": \"\",\n \"installedSoftware\": \"\",\n \"runningSoftware\": \"\",\n \"startupPrograms\": \"\",\n \"storage\": \"\",\n \"video\": \"\",\n \"network\": \"\",\n \"operatingSystem\": \"\",\n \"environmentVariables\": \"\",\n \"processes\": \"\",\n \"logicalDrives\": \"\",\n \"devices\": \"\",\n \"services\": \"\",\n \"systemDrivers\": \"\",\n \"signedDrivers\": \"\",\n \"eventViewer\": \"\",\n \"bios\": \"\"\n },\n {\n \"systemSummary\": \"\",\n \"browser\": \"\",\n \"hardware\": \"\",\n \"installedSoftware\": \"\",\n \"runningSoftware\": \"\",\n \"startupPrograms\": \"\",\n \"storage\": \"\",\n \"video\": \"\",\n \"network\": \"\",\n \"operatingSystem\": \"\",\n \"environmentVariables\": \"\",\n \"processes\": \"\",\n \"logicalDrives\": \"\",\n \"devices\": \"\",\n \"services\": \"\",\n \"systemDrivers\": \"\",\n \"signedDrivers\": \"\",\n \"eventViewer\": \"\",\n \"bios\": \"\"\n }\n ]\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 405, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json;charset=UTF-8" - } - ], - "name": "OK", + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [ { "description": "e.g. UTC", "key": "timezone", "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" } ], "method": "GET", @@ -88869,27 +90123,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "OK" + "status": "Method Not Allowed" }, { "_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": [ { @@ -88905,33 +90169,61 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Gone" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 405, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"recordingId\": \"\",\n \"topic\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"accessTime\": \"\",\n \"viewed\": \"\",\n \"downloaded\": \"\"\n },\n {\n \"recordingId\": \"\",\n \"topic\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"accessTime\": \"\",\n \"viewed\": \"\",\n \"downloaded\": \"\"\n }\n ]\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;charset=UTF-8" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { "header": [ { "description": "e.g. UTC", "key": "timezone", "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], "method": "GET", @@ -88941,27 +90233,37 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Method Not Allowed" + "status": "OK" }, { "_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": { "header": [ { @@ -88977,19 +90279,29 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, - "status": "Unsupported Media Type" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -89013,31 +90325,36 @@ ], "path": [ "recordingReport", - "meetingArchives", - ":archiveId" + "accessDetail" ], - "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", - "variable": [ + "query": [ { - "description": "A unique identifier for the meeting archive summary.", - "key": "archiveId" + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" } - ] + ], + "raw": "{{baseUrl}}/recordingReport/accessDetail?recordingId=&hostEmail=&max=10" } }, "status": "Conflict" } ] - } - ], - "name": "Recording Report" - }, - { - "item": [ + }, { - "name": "List Recordings", + "name": "List Meeting Archive Summaries", "request": { - "description": "Lists recordings. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nOnly recordings of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. **NOTE**: when `meetingId` is specified, parameter of `siteUrl` will be ignored.\n\n* If `siteUrl` is specified, recordings of the specified site will be listed; otherwise, the API lists recordings of all the user's sites. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + "description": "Lists of meeting archive summaries. You can specify a date range and the maximum number of meeting archive summaries to return.\n\nMeeting archive summaries are only available to full administrators, not even the meeting host.\n\nThe list returned is sorted in descending order by the date and time that the archives were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the meeting archive summaries of the specified site will be listed; otherwise, meeting archive summaries of the user's preferred site will be listed. All available Webex sites and the preferred site of the user can be retrieved by the `Get Site List` API.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", "header": [ { "description": "e.g. UTC", @@ -89055,76 +90372,42 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 504, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method 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": { "header": [ { @@ -89139,77 +90422,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Method Not Allowed" + "status": "Gateway Timeout" }, { "_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": { "header": [ { @@ -89224,77 +90473,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Bad Gateway" + "status": "Not Found" }, { "_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": { "header": [ { @@ -89309,77 +90524,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Service Unavailable" + "status": "Unsupported Media Type" }, { "_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": [ { @@ -89394,77 +90575,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Service Unavailable" }, { "_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": [ { @@ -89479,83 +90626,67 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Too Many Requests" + "status": "Conflict" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 415, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"archiveId\": \"\",\n \"serviceType\": \"EventCenter\",\n \"title\": \"\",\n \"createTime\": \"\"\n },\n {\n \"archiveId\": \"\",\n \"serviceType\": \"SupportCenter\",\n \"title\": \"\",\n \"createTime\": \"\"\n }\n ]\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;charset=UTF-8" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { "header": [ { "description": "e.g. UTC", "key": "timezone", "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], "method": "GET", @@ -89564,69 +90695,35 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Unsupported Media Type" + "status": "OK" }, { "_postman_previewlanguage": "text", @@ -89649,66 +90746,32 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, "status": "Bad Request" @@ -89716,10 +90779,10 @@ { "_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": [ { @@ -89734,77 +90797,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Conflict" + "status": "Gone" }, { "_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": { "header": [ { @@ -89819,77 +90848,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Gateway Timeout" + "status": "Internal Server Error" }, { "_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": { "header": [ { @@ -89904,77 +90899,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Gone" + "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": { "header": [ { @@ -89989,101 +90950,49 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Not Found" + "status": "Bad Gateway" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"available\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"available\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json;charset=UTF-8" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" - } - ], - "name": "OK", + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [ { "description": "e.g. UTC", "key": "timezone", "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" } ], "method": "GET", @@ -90092,77 +91001,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "OK" + "status": "Unauthorized" }, { "_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": { "header": [ { @@ -90177,77 +91052,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_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": [ { @@ -90262,77 +91103,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "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": [ { @@ -90347,77 +91154,43 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Precondition Required" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 429, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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": [ { @@ -90432,76 +91205,42 @@ "{{baseUrl}}" ], "path": [ - "recordings" + "recordingReport", + "meetingArchiveSummaries" ], "query": [ { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "key": "max", "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + "value": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", - "key": "hostEmail", - "value": "" - }, - { - "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.", "key": "siteUrl", "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", - "key": "status", - "value": "available" } ], - "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordingReport/meetingArchiveSummaries?max=10&from=If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=" } }, - "status": "Unauthorized" + "status": "Too Many Requests" } ] }, { - "name": "List Recordings For an Admin or Compliance Officer", + "name": "Get Meeting Archive Details", "request": { - "description": "List recordings for an admin or compliance officer. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. Please note that when `meetingId` is specified, parameters of `siteUrl`, `from`, and `to` will be ignored.\n\n* If `siteUrl` is specified, all the recordings on the specified site are listed; otherwise, all the recordings on the admin user's or compliance officer's preferred site are listed. All the available Webex sites and the admin user's or compliance officer's preferred site can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + "description": "Retrieves details for a meeting archive report with a specified archive ID, which contains recording metadata.\n\nMeeting archive details are only available to full administrators, not even the meeting host.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", "header": [ { "description": "e.g. UTC", @@ -90519,72 +91258,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId", "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + ] } }, "response": [ { "_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": [ { @@ -90599,73 +91294,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - }, - { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + ] } }, - "status": "Bad Gateway" + "status": "Too Many Requests" }, { "_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": [ { @@ -90680,73 +91330,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + ] } }, - "status": "Too Many Requests" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 502, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [ { @@ -90761,73 +91366,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + ] } }, - "status": "Precondition Required" + "status": "Bad Gateway" }, { "_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": { "header": [ { @@ -90842,73 +91402,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 423, "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": "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": [ { @@ -90923,73 +91438,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + ] } }, - "status": "Unsupported Media Type" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": [ { @@ -91004,73 +91474,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + ] } }, - "status": "Conflict" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 401, "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": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [ { @@ -91085,73 +91510,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_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": [ { @@ -91166,73 +91546,28 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } - ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_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": [ { @@ -91247,66 +91582,373 @@ "{{baseUrl}}" ], "path": [ - "admin", - "recordings" + "recordingReport", + "meetingArchives", + ":archiveId" ], - "query": [ - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", - "key": "meetingId", - "value": "" - }, + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordingReport", + "meetingArchives", + ":archiveId" + ], + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordingReport", + "meetingArchives", + ":archiveId" + ], + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"archiveId\": \"\",\n \"serviceType\": \"SupportCenter\",\n \"title\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"participants\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"joinedTime\": \"\",\n \"leftTime\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"joinedTime\": \"\",\n \"leftTime\": \"\",\n \"email\": \"\"\n }\n ],\n \"chats\": [\n {\n \"type\": \"\",\n \"senderName\": \"\",\n \"chatTime\": \"\",\n \"target\": \"\",\n \"text\": \"\"\n },\n {\n \"type\": \"\",\n \"senderName\": \"\",\n \"chatTime\": \"\",\n \"target\": \"\",\n \"text\": \"\"\n }\n ],\n \"polls\": [\n {\n \"type\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"content\": {\n \"questionCount\": \"\",\n \"userCount\": \"\",\n \"votedUserCount\": \"\",\n \"questions\": [\n {\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"question\": {\n \"choiceCount\": \"\",\n \"type\": \"\",\n \"text\": \"\"\n },\n \"answerSummary\": [\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n },\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n }\n ],\n \"respondents\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"question\": {\n \"choiceCount\": \"\",\n \"type\": \"\",\n \"text\": \"\"\n },\n \"answerSummary\": [\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n },\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n }\n ],\n \"respondents\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n }\n },\n {\n \"type\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"content\": {\n \"questionCount\": \"\",\n \"userCount\": \"\",\n \"votedUserCount\": \"\",\n \"questions\": [\n {\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"question\": {\n \"choiceCount\": \"\",\n \"type\": \"\",\n \"text\": \"\"\n },\n \"answerSummary\": [\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n },\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n }\n ],\n \"respondents\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"question\": {\n \"choiceCount\": \"\",\n \"type\": \"\",\n \"text\": \"\"\n },\n \"answerSummary\": [\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n },\n {\n \"totalRespondents\": \"\",\n \"isCorrect\": \"\",\n \"text\": \"\",\n \"voteUsers\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ]\n }\n ],\n \"respondents\": [\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"correlationId\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"answers\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n }\n }\n ],\n \"qas\": [\n {\n \"priority\": \"\",\n \"type\": \"\",\n \"displayName\": \"\",\n \"questionTime\": \"\",\n \"target\": \"\",\n \"question\": \"\",\n \"answers\": [\n {\n \"responseMode\": \"\",\n \"displayName\": \"\",\n \"correlationId\": \"\",\n \"email\": \"\",\n \"answerTime\": \"\",\n \"text\": \"\"\n },\n {\n \"responseMode\": \"\",\n \"displayName\": \"\",\n \"correlationId\": \"\",\n \"email\": \"\",\n \"answerTime\": \"\",\n \"text\": \"\"\n }\n ]\n },\n {\n \"priority\": \"\",\n \"type\": \"\",\n \"displayName\": \"\",\n \"questionTime\": \"\",\n \"target\": \"\",\n \"question\": \"\",\n \"answers\": [\n {\n \"responseMode\": \"\",\n \"displayName\": \"\",\n \"correlationId\": \"\",\n \"email\": \"\",\n \"answerTime\": \"\",\n \"text\": \"\"\n },\n {\n \"responseMode\": \"\",\n \"displayName\": \"\",\n \"correlationId\": \"\",\n \"email\": \"\",\n \"answerTime\": \"\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"systemInfos\": [\n {\n \"displayName\": \"\",\n \"catalogs\": [\n {\n \"systemSummary\": \"\",\n \"browser\": \"\",\n \"hardware\": \"\",\n \"installedSoftware\": \"\",\n \"runningSoftware\": \"\",\n \"startupPrograms\": \"\",\n \"storage\": \"\",\n \"video\": \"\",\n \"network\": \"\",\n \"operatingSystem\": \"\",\n \"environmentVariables\": \"\",\n \"processes\": \"\",\n \"logicalDrives\": \"\",\n \"devices\": \"\",\n \"services\": \"\",\n \"systemDrivers\": \"\",\n \"signedDrivers\": \"\",\n \"eventViewer\": \"\",\n \"bios\": \"\"\n },\n {\n \"systemSummary\": \"\",\n \"browser\": \"\",\n \"hardware\": \"\",\n \"installedSoftware\": \"\",\n \"runningSoftware\": \"\",\n \"startupPrograms\": \"\",\n \"storage\": \"\",\n \"video\": \"\",\n \"network\": \"\",\n \"operatingSystem\": \"\",\n \"environmentVariables\": \"\",\n \"processes\": \"\",\n \"logicalDrives\": \"\",\n \"devices\": \"\",\n \"services\": \"\",\n \"systemDrivers\": \"\",\n \"signedDrivers\": \"\",\n \"eventViewer\": \"\",\n \"bios\": \"\"\n }\n ]\n },\n {\n \"displayName\": \"\",\n \"catalogs\": [\n {\n \"systemSummary\": \"\",\n \"browser\": \"\",\n \"hardware\": \"\",\n \"installedSoftware\": \"\",\n \"runningSoftware\": \"\",\n \"startupPrograms\": \"\",\n \"storage\": \"\",\n \"video\": \"\",\n \"network\": \"\",\n \"operatingSystem\": \"\",\n \"environmentVariables\": \"\",\n \"processes\": \"\",\n \"logicalDrives\": \"\",\n \"devices\": \"\",\n \"services\": \"\",\n \"systemDrivers\": \"\",\n \"signedDrivers\": \"\",\n \"eventViewer\": \"\",\n \"bios\": \"\"\n },\n {\n \"systemSummary\": \"\",\n \"browser\": \"\",\n \"hardware\": \"\",\n \"installedSoftware\": \"\",\n \"runningSoftware\": \"\",\n \"startupPrograms\": \"\",\n \"storage\": \"\",\n \"video\": \"\",\n \"network\": \"\",\n \"operatingSystem\": \"\",\n \"environmentVariables\": \"\",\n \"processes\": \"\",\n \"logicalDrives\": \"\",\n \"devices\": \"\",\n \"services\": \"\",\n \"systemDrivers\": \"\",\n \"signedDrivers\": \"\",\n \"eventViewer\": \"\",\n \"bios\": \"\"\n }\n ]\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json;charset=UTF-8" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordingReport", + "meetingArchives", + ":archiveId" + ], + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "MP4" - }, + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordingReport", + "meetingArchives", + ":archiveId" + ], + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "EventCenter" - }, + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordingReport", + "meetingArchives", + ":archiveId" + ], + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", - "key": "status", - "value": "available" + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "path": [ + "recordingReport", + "meetingArchives", + ":archiveId" + ], + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ + { + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" + } + ] } }, - "status": "Forbidden" + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordingReport", + "meetingArchives", + ":archiveId" + ], + "raw": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId", + "variable": [ + { + "description": "A unique identifier for the meeting archive summary.", + "key": "archiveId" + } + ] + } + }, + "status": "Conflict" + } + ] + } + ], + "name": "Recording Report" + }, + { + "item": [ + { + "name": "List Recordings", + "request": { + "description": "
This API is still supported and behaves the same as before, but will be deprecated in the future. Due to limited support for special characters when filtering recordings by `topic`, it is recommended to use the new [Query Recordings](/docs/api/v1/recordings/query-recordings) API instead.
\n\nLists recordings. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nOnly recordings of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. **NOTE**: when `meetingId` is specified, parameter of `siteUrl` will be ignored.\n\n* If `siteUrl` is specified, recordings of the specified site will be listed; otherwise, the API lists recordings of all the user's sites. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "response": [ { "_postman_previewlanguage": "text", "body": null, @@ -91328,7 +91970,6 @@ "{{baseUrl}}" ], "path": [ - "admin", "recordings" ], "query": [ @@ -91338,32 +91979,37 @@ "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", "key": "meetingId", "value": "" }, { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" }, { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", "key": "integrationTag", "value": "" }, { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", "key": "topic", "value": "" }, @@ -91373,17 +92019,17 @@ "value": "MP4" }, { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", "key": "serviceType", "value": "EventCenter" }, { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", "key": "status", "value": "available" } ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" } }, "status": "Method Not Allowed" @@ -91391,10 +92037,10 @@ { "_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": { "header": [ { @@ -91409,7 +92055,6 @@ "{{baseUrl}}" ], "path": [ - "admin", "recordings" ], "query": [ @@ -91419,32 +92064,37 @@ "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", "key": "meetingId", "value": "" }, { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" }, { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", "key": "integrationTag", "value": "" }, { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", "key": "topic", "value": "" }, @@ -91454,20 +92104,20 @@ "value": "MP4" }, { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", "key": "serviceType", "value": "EventCenter" }, { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", "key": "status", "value": "available" } ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" } }, - "status": "Bad Request" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", @@ -91490,7 +92140,6 @@ "{{baseUrl}}" ], "path": [ - "admin", "recordings" ], "query": [ @@ -91500,32 +92149,37 @@ "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", "key": "meetingId", "value": "" }, { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" }, { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", "key": "integrationTag", "value": "" }, { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", "key": "topic", "value": "" }, @@ -91535,17 +92189,17 @@ "value": "MP4" }, { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", "key": "serviceType", "value": "EventCenter" }, { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", "key": "status", "value": "available" } ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" } }, "status": "Service Unavailable" @@ -91553,10 +92207,10 @@ { "_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": [ { @@ -91571,7 +92225,6 @@ "{{baseUrl}}" ], "path": [ - "admin", "recordings" ], "query": [ @@ -91581,32 +92234,37 @@ "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", "key": "meetingId", "value": "" }, { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" }, { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", "key": "integrationTag", "value": "" }, { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", "key": "topic", "value": "" }, @@ -91616,28 +92274,28 @@ "value": "MP4" }, { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", "key": "serviceType", "value": "EventCenter" }, { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", "key": "status", "value": "available" } ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" } }, - "status": "Gateway Timeout" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": [ { @@ -91652,7 +92310,6 @@ "{{baseUrl}}" ], "path": [ - "admin", "recordings" ], "query": [ @@ -91662,32 +92319,37 @@ "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", "key": "meetingId", "value": "" }, { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" }, { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", "key": "integrationTag", "value": "" }, { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", "key": "topic", "value": "" }, @@ -91697,52 +92359,34 @@ "value": "MP4" }, { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", "key": "serviceType", "value": "EventCenter" }, { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", "key": "status", "value": "available" } ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" } }, - "status": "Gone" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"TrainingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"status\": \"deleted\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"TrainingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"status\": \"available\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 415, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json;charset=UTF-8" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" - } - ], - "name": "OK", + "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": [ { "description": "e.g. UTC", "key": "timezone", "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" } ], "method": "GET", @@ -91751,7 +92395,6 @@ "{{baseUrl}}" ], "path": [ - "admin", "recordings" ], "query": [ @@ -91761,32 +92404,37 @@ "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", "key": "meetingId", "value": "" }, { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" }, { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", "key": "integrationTag", "value": "" }, { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", "key": "topic", "value": "" }, @@ -91796,28 +92444,28 @@ "value": "MP4" }, { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", "key": "serviceType", "value": "EventCenter" }, { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", "key": "status", "value": "available" } ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" } }, - "status": "OK" + "status": "Unsupported Media Type" }, { "_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": [ { @@ -91832,7 +92480,6 @@ "{{baseUrl}}" ], "path": [ - "admin", "recordings" ], "query": [ @@ -91842,32 +92489,37 @@ "value": "10" }, { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." }, { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "key": "to", "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." }, { - "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", "key": "meetingId", "value": "" }, { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "key": "siteUrl", "value": "" }, { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", "key": "integrationTag", "value": "" }, { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", "key": "topic", "value": "" }, @@ -91877,189 +92529,3608 @@ "value": "MP4" }, { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", "key": "serviceType", "value": "EventCenter" }, { - "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", "key": "status", "value": "available" } ], - "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" } }, - "status": "Not Found" - } - ] - }, - { - "name": "Delete a Recording By an Admin", - "request": { - "description": "Removes a recording with a specified recording ID by an admin. The deleted recording cannot be recovered. It will be inaccessible to regular users (host, attendees and shared) or an admin, but it will be still available to the Compliance Officer.\n\nAny recording on a site which is managed by the admin can be deleted by him.\n\nThe `temporaryDirectDownloadLinks` of a recording which are retrieved by the [Get Recording Details](/docs/api/v1/recordings/get-recording-details) API are still available to Compliance Officers even if the recording has been deleted.", - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "recordings", - ":recordingId" - ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] - } - }, - "response": [ + "status": "Bad Request" + }, { "_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": "DELETE", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "recordings", - ":recordingId" + "recordings" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" } - ] + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" } }, - "status": "Method Not Allowed" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 504, "cookie": [], "header": [], - "name": "No Content", + "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", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "recordings", - ":recordingId" + "recordings" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" } - ] + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" } }, - "status": "No Content" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 410, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], - "method": "DELETE", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "recordings", - ":recordingId" + "recordings" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" } - ] + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" } }, - "status": "Bad Gateway" + "status": "Gone" }, { "_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", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", - "recordings", - ":recordingId" + "recordings" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" } - ] + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" } }, - "status": "Too Many Requests" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 400, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"TrainingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"available\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"available\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "code": 200, "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;charset=UTF-8" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { - "header": [], - "method": "DELETE", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "status": "Internal Server Error" + }, + { + "_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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.", + "key": "hostEmail", + "value": "" + }, + { + "description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&hostEmail=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "status": "Unauthorized" + } + ] + }, + { + "name": "List Recordings For an Admin or Compliance Officer", + "request": { + "description": "
This API is still supported and behaves the same as before, but will be deprecated in the future. Due to limited support for special characters when filtering recordings by `topic`, it is recommended to use the new [Query Recordings For an Admin or Compliance Officer](/docs/api/v1/recordings/query-recordings-for-an-admin-or-compliance-officer) API instead.
\n\nList recordings for an admin or compliance officer. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. Please note that when `meetingId` is specified, parameters of `siteUrl`, `from`, and `to` will be ignored.\n\n* If `siteUrl` is specified, all the recordings on the specified site are listed; otherwise, all the recordings on the admin user's or compliance officer's preferred site are listed. All the available Webex sites and the admin user's or compliance officer's preferred site can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "status": "Precondition Required" + }, + { + "_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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "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).", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "status": "Method Not Allowed" + }, + { + "_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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"TrainingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"status\": \"deleted\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"TrainingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"status\": \"available\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json;charset=UTF-8" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings" + ], + "query": [ + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.", + "key": "meetingId", + "value": "" + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", + "value": "" + }, + { + "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", + "key": "topic", + "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "MP4" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "EventCenter" + }, + { + "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.", + "key": "status", + "value": "available" + } + ], + "raw": "{{baseUrl}}/admin/recordings?max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&meetingId=&siteUrl=&integrationTag=&topic=&format=MP4&serviceType=EventCenter&status=available" + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Delete a Recording By an Admin", + "request": { + "description": "Removes a recording with a specified recording ID by an admin. The deleted recording cannot be recovered. It will be inaccessible to regular users (host, attendees and shared) or an admin, but it will be still available to the Compliance Officer.\n\nAny recording on a site which is managed by the admin can be deleted by him.\n\nThe `temporaryDirectDownloadLinks` of a recording which are retrieved by the [Get Recording Details](/docs/api/v1/recordings/get-recording-details) API are still available to Compliance Officers even if the recording has been deleted.", + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "No Content" + }, + { + "_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": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_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": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_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": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_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": [ + "admin", + "recordings", + ":recordingId" + ], + "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Forbidden" + } + ] + }, + { + "name": "Get Recording Details", + "request": { + "description": "Retrieves details for a recording with a specified recording ID.\n\nOnly recordings of meetings hosted by or shared with the authenticated user may be retrieved.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*\n\n* `siteUrl`: Optional request header parameter. If specified, retrieve the recording details from that site; otherwise, retrieve it from the site which is implied based on the recording ID.", + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] + } + }, + "response": [ + { + "_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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"SupportCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"purged\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"temporaryDirectDownloadLinks\": {\n \"recordingDownloadLink\": \"\",\n \"audioDownloadLink\": \"\",\n \"transcriptDownloadLink\": \"\",\n \"expiration\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json;charset=UTF-8" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", ":recordingId" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "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": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "e.g. example.webex.com", + "key": "siteUrl", + "value": "" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Unauthorized" + } + ] + }, + { + "name": "Delete a Recording", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "description": "Removes a recording with a specified recording ID. The deleted recording cannot be recovered. If a Compliance Officer deletes another user's recording, the recording will be inaccessible to regular users (host, attendees and shared), but will be still available to the Compliance Officer.\n\nOnly recordings of meetings hosted by the authenticated user can be deleted.\n\nThe `temporaryDirectDownloadLinks` of a recording which are retrieved by the [Get Recording Details](/docs/api/v1/recordings/get-recording-details) API are still available to Compliance Officers even if the recording has been deleted.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", "variable": [ { "description": "A unique identifier for the recording.", @@ -92076,20 +96147,41 @@ "code": 404, "cookie": [], "header": [], - "name": "Not Found", + "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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", ":recordingId" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", "variable": [ { "description": "A unique identifier for the recording.", @@ -92103,23 +96195,44 @@ { "_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": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", ":recordingId" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", "variable": [ { "description": "A unique identifier for the recording.", @@ -92128,28 +96241,49 @@ ] } }, - "status": "Internal Server Error" + "status": "Unsupported Media Type" }, { "_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": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", ":recordingId" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", "variable": [ { "description": "A unique identifier for the recording.", @@ -92158,7 +96292,7 @@ ] } }, - "status": "Unsupported Media Type" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", @@ -92168,18 +96302,39 @@ "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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", ":recordingId" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", "variable": [ { "description": "A unique identifier for the recording.", @@ -92190,6 +96345,159 @@ }, "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Precondition Required" + }, { "_postman_previewlanguage": "text", "body": null, @@ -92198,18 +96506,39 @@ "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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", ":recordingId" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", "variable": [ { "description": "A unique identifier for the recording.", @@ -92228,18 +96557,39 @@ "header": [], "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", ":recordingId" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", "variable": [ { "description": "A unique identifier for the recording.", @@ -92253,23 +96603,44 @@ { "_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": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", ":recordingId" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", "variable": [ { "description": "A unique identifier for the recording.", @@ -92278,28 +96649,49 @@ ] } }, - "status": "Conflict" + "status": "No Content" }, { "_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": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", ":recordingId" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", "variable": [ { "description": "A unique identifier for the recording.", @@ -92308,28 +96700,49 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gone" }, { "_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": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", ":recordingId" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", "variable": [ { "description": "A unique identifier for the recording.", @@ -92338,28 +96751,49 @@ ] } }, - "status": "Gone" + "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": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", ":recordingId" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", "variable": [ { "description": "A unique identifier for the recording.", @@ -92368,7 +96802,58 @@ ] } }, - "status": "Precondition Required" + "status": "Too Many Requests" + }, + { + "_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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + ":recordingId" + ], + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId" + } + ] + } + }, + "status": "Conflict" }, { "_postman_previewlanguage": "text", @@ -92378,18 +96863,39 @@ "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 \"reason\": \"\",\n \"comment\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "recordings", ":recordingId" ], - "raw": "{{baseUrl}}/admin/recordings/:recordingId", + "query": [ + { + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "key": "hostEmail", + "value": "" + } + ], + "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", "variable": [ { "description": "A unique identifier for the recording.", @@ -92403,817 +96909,769 @@ ] }, { - "name": "Get Recording Details", + "name": "Move Recordings into the Recycle Bin", "request": { - "description": "Retrieves details for a recording with a specified recording ID.\n\nOnly recordings of meetings hosted by or shared with the authenticated user may be retrieved.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*\n\n* `siteUrl`: Optional request header parameter. If specified, retrieve the recording details from that site; otherwise, retrieve it from the site which is implied based on the recording ID.", - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "description": "Move recordings into the recycle bin with recording IDs. Recordings in the recycle bin can be recovered by [Restore Recordings from Recycle Bin](/docs/api/v1/recordings/restore-recordings-from-recycle-bin) API. If you'd like to empty recordings from the recycle bin, you can use [Purge Recordings from Recycle Bin](/docs/api/v1/recordings/purge-recordings-from-recycle-bin) API to purge all or some of them.\n\nOnly recordings of meetings hosted by the authenticated user can be moved into the recycle bin.\n\n* `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified.", + "header": [ { - "key": "Accept", - "value": "application/json;charset=UTF-8" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, "response": [ { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, - "status": "Not Found" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"SupportCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"purged\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"temporaryDirectDownloadLinks\": {\n \"recordingDownloadLink\": \"\",\n \"audioDownloadLink\": \"\",\n \"transcriptDownloadLink\": \"\",\n \"expiration\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 502, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json;charset=UTF-8" - } - ], - "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "key": "Accept", - "value": "application/json;charset=UTF-8" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, - "status": "OK" + "status": "Bad Gateway" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, - "status": "Conflict" + "status": "Precondition Required" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, - "status": "Precondition Required" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 204, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "No Content", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, - "status": "Bad Request" + "status": "No Content" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, - "status": "Method Not Allowed" + "status": "Not Found" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, - "status": "Bad Gateway" + "status": "Forbidden" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, - "status": "Gone" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, - "status": "Internal Server Error" + "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 410, "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": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, - "status": "Gateway Timeout" + "status": "Gone" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Conflict" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, - "status": "Forbidden" + "status": "Unsupported Media Type" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, - "status": "Unsupported Media Type" + "status": "Bad Request" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 429, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + }, + "header": [ { - "description": "e.g. example.webex.com", - "key": "siteUrl", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "softDelete" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" } }, - "status": "Unauthorized" + "status": "Too Many Requests" } ] }, { - "name": "Delete a Recording", + "name": "Restore Recordings from Recycle Bin", "request": { "body": { "mode": "raw", @@ -93223,49 +97681,42 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, - "description": "Removes a recording with a specified recording ID. The deleted recording cannot be recovered. If a Compliance Officer deletes another user's recording, the recording will be inaccessible to regular users (host, attendees and shared), but will be still available to the Compliance Officer.\n\nOnly recordings of meetings hosted by the authenticated user can be deleted.\n\nThe `temporaryDirectDownloadLinks` of a recording which are retrieved by the [Get Recording Details](/docs/api/v1/recordings/get-recording-details) API are still available to Compliance Officers even if the recording has been deleted.", + "description": "Restore all or some recordings from the recycle bin. Only recordings of meetings hosted by the authenticated user can be restored from recycle bin.\n\n* If `restoreAll` is `true`, `recordingIds` should be empty.\n\n* If `restoreAll` is `false`, `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified.", "header": [ { "key": "Content-Type", "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, "response": [ { "_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": { "body": { "mode": "raw", @@ -93275,7 +97726,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -93283,40 +97734,34 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Bad Request" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 423, "cookie": [], "header": [], - "name": "Not Found", + "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", @@ -93326,7 +97771,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -93334,32 +97779,26 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Not Found" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", @@ -93377,7 +97816,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -93385,29 +97824,23 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, "status": "Unsupported Media Type" @@ -93415,10 +97848,10 @@ { "_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": { "body": { "mode": "raw", @@ -93428,7 +97861,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -93436,40 +97869,34 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Method Not Allowed" + "status": "Not Found" }, { "_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", @@ -93479,7 +97906,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -93487,40 +97914,34 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Service Unavailable" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 428, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "body": { "mode": "raw", @@ -93530,7 +97951,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -93538,40 +97959,34 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Bad Gateway" + "status": "Precondition Required" }, { "_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", @@ -93581,7 +97996,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -93589,40 +98004,34 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Gateway" }, { "_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": { "body": { "mode": "raw", @@ -93632,7 +98041,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -93640,40 +98049,34 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Precondition Required" + "status": "Forbidden" }, { "_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", @@ -93683,7 +98086,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -93691,40 +98094,34 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Gateway Timeout" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 405, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -93734,7 +98131,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -93742,40 +98139,34 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Unauthorized" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 429, "cookie": [], "header": [], - "name": "No Content", + "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", @@ -93785,7 +98176,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -93793,40 +98184,34 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "No Content" + "status": "Too Many Requests" }, { "_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": { "body": { "mode": "raw", @@ -93836,7 +98221,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -93844,40 +98229,34 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Gone" + "status": "Gateway Timeout" }, { "_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": { "body": { "mode": "raw", @@ -93887,7 +98266,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -93895,40 +98274,34 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", - "value": "" - } - ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" + "value": "" } - ] + ], + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_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", @@ -93938,7 +98311,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -93946,40 +98319,34 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_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": "raw", @@ -93989,7 +98356,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -93997,40 +98364,34 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Conflict" + "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", @@ -94040,7 +98401,7 @@ "language": "json" } }, - "raw": "{\n \"reason\": \"\",\n \"comment\": \"\"\n}" + "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94048,37 +98409,31 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "recordings", - ":recordingId" + "restore" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.", + "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/:recordingId?hostEmail=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "raw": "{{baseUrl}}/recordings/restore?hostEmail=" } }, - "status": "Forbidden" + "status": "Gone" } ] }, { - "name": "Move Recordings into the Recycle Bin", + "name": "Purge Recordings from Recycle Bin", "request": { "body": { "mode": "raw", @@ -94088,9 +98443,9 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, - "description": "Move recordings into the recycle bin with recording IDs. Recordings in the recycle bin can be recovered by [Restore Recordings from Recycle Bin](/docs/api/v1/recordings/restore-recordings-from-recycle-bin) API. If you'd like to empty recordings from the recycle bin, you can use [Purge Recordings from Recycle Bin](/docs/api/v1/recordings/purge-recordings-from-recycle-bin) API to purge all or some of them.\n\nOnly recordings of meetings hosted by the authenticated user can be moved into the recycle bin.\n\n* `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified.", + "description": "Purge recordings from recycle bin with recording IDs or purge all the recordings that are in the recycle bin.\n\nOnly recordings of meetings hosted by the authenticated user can be purged from recycle bin.\n\n* If `purgeAll` is `true`, `recordingIds` should be empty.\n\n* If `purgeAll` is `false`, `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified.", "header": [ { "key": "Content-Type", @@ -94104,26 +98459,26 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, "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": { "body": { "mode": "raw", @@ -94133,7 +98488,7 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94148,27 +98503,27 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Service Unavailable" + "status": "Precondition Required" }, { "_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": { "body": { "mode": "raw", @@ -94178,7 +98533,7 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94193,27 +98548,27 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Bad Gateway" + "status": "Too Many Requests" }, { "_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", @@ -94223,7 +98578,7 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94238,27 +98593,27 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Precondition Required" + "status": "Unauthorized" }, { "_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": { "body": { "mode": "raw", @@ -94268,7 +98623,7 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94283,27 +98638,27 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Method Not Allowed" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 504, "cookie": [], "header": [], - "name": "No Content", + "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", @@ -94313,7 +98668,7 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94328,27 +98683,27 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "No Content" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 415, "cookie": [], "header": [], - "name": "Not Found", + "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", @@ -94358,7 +98713,7 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94373,27 +98728,27 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Not Found" + "status": "Unsupported Media Type" }, { "_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", @@ -94403,7 +98758,7 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94418,27 +98773,27 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Forbidden" + "status": "Not Found" }, { "_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": { "body": { "mode": "raw", @@ -94448,7 +98803,7 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94463,27 +98818,27 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Method Not Allowed" }, { "_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": { "body": { "mode": "raw", @@ -94493,7 +98848,7 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94508,27 +98863,27 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Gateway Timeout" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 204, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "No Content", "originalRequest": { "body": { "mode": "raw", @@ -94538,7 +98893,7 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94553,19 +98908,19 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Unauthorized" + "status": "No Content" }, { "_postman_previewlanguage": "text", @@ -94583,7 +98938,7 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94598,16 +98953,16 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, "status": "Gone" @@ -94615,10 +98970,10 @@ { "_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", @@ -94628,7 +98983,7 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94643,27 +98998,27 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Conflict" + "status": "Forbidden" }, { "_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", @@ -94673,7 +99028,7 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94688,27 +99043,27 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Unsupported Media Type" + "status": "Conflict" }, { "_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": { "body": { "mode": "raw", @@ -94718,7 +99073,7 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94733,19 +99088,19 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Bad Request" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", @@ -94763,7 +99118,7 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94778,16 +99133,16 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, "status": "Internal Server Error" @@ -94795,10 +99150,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 400, "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": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "body": { "mode": "raw", @@ -94808,7 +99163,7 @@ "language": "json" } }, - "raw": "{\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" }, "header": [ { @@ -94823,24 +99178,24 @@ ], "path": [ "recordings", - "softDelete" + "purge" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user", + "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", "key": "hostEmail", "value": "" } ], - "raw": "{{baseUrl}}/recordings/softDelete?hostEmail=" + "raw": "{{baseUrl}}/recordings/purge?hostEmail=" } }, - "status": "Too Many Requests" + "status": "Bad Request" } ] }, { - "name": "Restore Recordings from Recycle Bin", + "name": "Share a Recording", "request": { "body": { "mode": "raw", @@ -94850,9 +99205,9 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, - "description": "Restore all or some recordings from the recycle bin. Only recordings of meetings hosted by the authenticated user can be restored from recycle bin.\n\n* If `restoreAll` is `true`, `recordingIds` should be empty.\n\n* If `restoreAll` is `false`, `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified.", + "description": "Share or unshare a recording with other users by recording ID and email addresses.", "header": [ { "key": "Content-Type", @@ -94866,26 +99221,27 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", + "description": "A unique identifier for the recording.", + "key": "recordingId", "value": "" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 409, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. 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", @@ -94895,7 +99251,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -94910,27 +99266,27 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" + "description": "A unique identifier for the recording.", + "key": "recordingId" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, - "status": "Service Unavailable" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 500, "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": "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", @@ -94940,7 +99296,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -94955,27 +99311,27 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" + "description": "A unique identifier for the recording.", + "key": "recordingId" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Internal Server Error" }, { "_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": { "body": { "mode": "raw", @@ -94985,7 +99341,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -95000,27 +99356,27 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" + "description": "A unique identifier for the recording.", + "key": "recordingId" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, - "status": "Unsupported Media Type" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 405, "cookie": [], "header": [], - "name": "Not Found", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -95030,7 +99386,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -95045,27 +99401,27 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" + "description": "A unique identifier for the recording.", + "key": "recordingId" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, - "status": "Not Found" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 504, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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", @@ -95075,7 +99431,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -95090,27 +99446,27 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" + "description": "A unique identifier for the recording.", + "key": "recordingId" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, - "status": "Bad Request" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 400, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "body": { "mode": "raw", @@ -95120,7 +99476,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -95135,27 +99491,27 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" + "description": "A unique identifier for the recording.", + "key": "recordingId" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, - "status": "Precondition Required" + "status": "Bad Request" }, { "_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", @@ -95165,7 +99521,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -95180,27 +99536,27 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" + "description": "A unique identifier for the recording.", + "key": "recordingId" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, - "status": "Bad Gateway" + "status": "Service Unavailable" }, { "_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", @@ -95210,7 +99566,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -95225,27 +99581,27 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" + "description": "A unique identifier for the recording.", + "key": "recordingId" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_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", @@ -95255,7 +99611,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -95270,27 +99626,27 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" + "description": "A unique identifier for the recording.", + "key": "recordingId" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, - "status": "Unauthorized" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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", @@ -95300,7 +99656,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -95315,27 +99671,27 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" + "description": "A unique identifier for the recording.", + "key": "recordingId" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, - "status": "Method Not Allowed" + "status": "Gone" }, { "_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", @@ -95345,7 +99701,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -95360,27 +99716,27 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" + "description": "A unique identifier for the recording.", + "key": "recordingId" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 502, "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 Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -95390,7 +99746,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -95405,27 +99761,27 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" + "description": "A unique identifier for the recording.", + "key": "recordingId" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, - "status": "Gateway Timeout" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 429, "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": "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", @@ -95435,7 +99791,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -95450,27 +99806,27 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" + "description": "A unique identifier for the recording.", + "key": "recordingId" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_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": { "body": { "mode": "raw", @@ -95480,7 +99836,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -95495,27 +99851,27 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" + "description": "A unique identifier for the recording.", + "key": "recordingId" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, - "status": "Internal Server Error" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 428, "cookie": [], "header": [], - "name": "No Content", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "body": { "mode": "raw", @@ -95525,7 +99881,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -95540,27 +99896,27 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" + "description": "A unique identifier for the recording.", + "key": "recordingId" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, - "status": "No Content" + "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": { "body": { "mode": "raw", @@ -95570,7 +99926,7 @@ "language": "json" } }, - "raw": "{\n \"restoreAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, "header": [ { @@ -95585,1634 +99941,2025 @@ ], "path": [ "recordings", - "restore" + ":recordingId", + "accessList" ], - "query": [ + "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "variable": [ { - "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.", - "key": "hostEmail", - "value": "" + "description": "A unique identifier for the recording.", + "key": "recordingId" } - ], - "raw": "{{baseUrl}}/recordings/restore?hostEmail=" + ] } }, - "status": "Gone" + "status": "No Content" } ] }, { - "name": "Purge Recordings from Recycle Bin", + "name": "List Group Recordings", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, - "description": "Purge recordings from recycle bin with recording IDs or purge all the recordings that are in the recycle bin.\n\nOnly recordings of meetings hosted by the authenticated user can be purged from recycle bin.\n\n* If `purgeAll` is `true`, `recordingIds` should be empty.\n\n* If `purgeAll` is `false`, `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified.", + "description": "List group recordings for a service app which has group recording access. You can specify a date range, the maximum number of recordings to return, and `personId` or `hostEmail` of whom the recordings will be retrieved.\n\n* The list returned is sorted in descending order by the date and time that the recordings were created.\n\n* Only recordings which are in the `available` status and not shared by others can be listed. Those in the `deleted` or `purged` status or shared by others can't be listed.\n\n* Long result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the API lists group recordings on the specified site; otherwise, the API lists group recordings on all the sites managed by the service app. All the sites managed by a service app can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* One of the `personId` parameter and `hostEmail` header must be specified so that only recordings of meetings hosted by the person of `personId` or `hostEmail` will be returned.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.\n\n* `hostEmail`: Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, "response": [ { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, - "status": "Precondition Required" + "status": "Method Not Allowed" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, - "status": "Too Many Requests" + "status": "Precondition Required" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"MeetingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"deleted\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"purged\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" + "header": [ + { + "key": "Content-Type", + "value": "application/json;charset=UTF-8" }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", + "originalRequest": { "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, - "status": "Unauthorized" + "status": "OK" }, { "_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 \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, - "status": "Bad Gateway" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 410, "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": "Gone: The requested resource is no longer available.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, - "status": "Gateway Timeout" + "status": "Gone" }, { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, - "status": "Unsupported Media Type" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 401, "cookie": [], "header": [], - "name": "Not Found", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, - "status": "Method Not Allowed" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 500, "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": "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 \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 429, "cookie": [], "header": [], - "name": "No Content", + "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 \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, - "status": "No Content" + "status": "Too Many Requests" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, - "status": "Gone" + "status": "Bad Gateway" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, - "status": "Forbidden" + "status": "Unsupported Media Type" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, - "status": "Conflict" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 403, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "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 \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, - "status": "Service Unavailable" + "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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 504, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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 \"purgeAll\": \"\",\n \"recordingIds\": [\n \"\",\n \"\"\n ],\n \"siteUrl\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "recordings", - "purge" + "group", + "recordings" ], "query": [ { - "description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.", - "key": "hostEmail", + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + }, + { + "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", + "key": "max", + "value": "10" + }, + { + "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", + "key": "from", + "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." + }, + { + "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", + "key": "to", + "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." + }, + { + "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", + "key": "siteUrl", + "value": "" + }, + { + "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", + "key": "integrationTag", "value": "" + }, + { + "description": "Recording's file format. If specified, the API filters recordings by format.", + "key": "format", + "value": "ARF" + }, + { + "description": "The service type for recordings. If specified, the API filters recordings by service type.", + "key": "serviceType", + "value": "SupportCenter" } ], - "raw": "{{baseUrl}}/recordings/purge?hostEmail=" + "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&format=ARF&serviceType=SupportCenter" } }, - "status": "Bad Request" + "status": "Gateway Timeout" } ] }, { - "name": "Share a Recording", + "name": "Get Group Recording Details", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, - "description": "Share or unshare a recording with other users by recording ID and email addresses.", + "description": "Retrieves details for a group recording for a service app which has group recording access.\n\n* Only recordings which are in the `available` status and not shared by others can be listed. Those in the `deleted` or `purged` status or shared by others can't be listed.\n\n* One of the `personId` parameter and `hostEmail` header must be specified so that only recordings of meetings hosted by the person of `personId` or `hostEmail` will be returned.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*\n\n* `hostEmail`: Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - ":recordingId", - "accessList" + ":recordingId" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "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 \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "recordings", - ":recordingId", - "accessList" - ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] - } - }, - "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).", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "recordings", - ":recordingId", - "accessList" - ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" } - }, - "status": "Internal Server Error" - }, + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ + { + "description": "A unique identifier for the recording.", + "key": "recordingId", + "value": "" + } + ] + } + }, + "response": [ { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - ":recordingId", - "accessList" + ":recordingId" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", - "variable": [ + "query": [ { - "description": "A unique identifier for the recording.", - "key": "recordingId" - } - ] - } - }, - "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" + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" } - }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "recordings", - ":recordingId", - "accessList" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", "variable": [ { "description": "A unique identifier for the recording.", - "key": "recordingId" + "key": "recordingId", + "value": "" } ] } }, - "status": "Method Not Allowed" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 502, "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 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 \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - ":recordingId", - "accessList" + ":recordingId" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "query": [ + { + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", "variable": [ { "description": "A unique identifier for the recording.", - "key": "recordingId" + "key": "recordingId", + "value": "" } ] } }, - "status": "Gateway Timeout" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 428, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "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 \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - ":recordingId", - "accessList" + ":recordingId" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "query": [ + { + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", "variable": [ { "description": "A unique identifier for the recording.", - "key": "recordingId" + "key": "recordingId", + "value": "" } ] } }, - "status": "Bad Request" + "status": "Precondition Required" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - ":recordingId", - "accessList" + ":recordingId" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "query": [ + { + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", "variable": [ { "description": "A unique identifier for the recording.", - "key": "recordingId" + "key": "recordingId", + "value": "" } ] } }, - "status": "Service Unavailable" + "status": "Method Not Allowed" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - ":recordingId", - "accessList" + ":recordingId" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "query": [ + { + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", "variable": [ { "description": "A unique identifier for the recording.", - "key": "recordingId" + "key": "recordingId", + "value": "" } ] } }, - "status": "Unauthorized" + "status": "Gateway Timeout" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - ":recordingId", - "accessList" + ":recordingId" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "query": [ + { + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", "variable": [ { "description": "A unique identifier for the recording.", - "key": "recordingId" + "key": "recordingId", + "value": "" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Conflict" }, { "_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", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - ":recordingId", - "accessList" + ":recordingId" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "query": [ + { + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", "variable": [ { "description": "A unique identifier for the recording.", - "key": "recordingId" + "key": "recordingId", + "value": "" } ] } }, - "status": "Gone" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 401, "cookie": [], "header": [], - "name": "Not Found", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - ":recordingId", - "accessList" + ":recordingId" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "query": [ + { + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", "variable": [ { "description": "A unique identifier for the recording.", - "key": "recordingId" + "key": "recordingId", + "value": "" } ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - ":recordingId", - "accessList" + ":recordingId" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "query": [ + { + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", "variable": [ { "description": "A unique identifier for the recording.", - "key": "recordingId" + "key": "recordingId", + "value": "" } ] } }, - "status": "Bad Gateway" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 400, "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": "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 \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - ":recordingId", - "accessList" + ":recordingId" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "query": [ + { + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", "variable": [ { "description": "A unique identifier for the recording.", - "key": "recordingId" + "key": "recordingId", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "Bad Request" }, { "_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": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } + "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, - "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - ":recordingId", - "accessList" + ":recordingId" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "query": [ + { + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", "variable": [ { "description": "A unique identifier for the recording.", - "key": "recordingId" + "key": "recordingId", + "value": "" } ] } }, - "status": "Unsupported Media Type" + "status": "Not Found" }, { "_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": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - ":recordingId", - "accessList" + ":recordingId" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "query": [ + { + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", "variable": [ { "description": "A unique identifier for the recording.", - "key": "recordingId" + "key": "recordingId", + "value": "" } ] } }, - "status": "Precondition Required" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 503, "cookie": [], "header": [], - "name": "No Content", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"hostEmail\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, + { + "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "hostEmail", + "value": "" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "group", "recordings", - ":recordingId", - "accessList" + ":recordingId" ], - "raw": "{{baseUrl}}/recordings/:recordingId/accessList", + "query": [ + { + "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "key": "personId", + "value": "" + } + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", "variable": [ { "description": "A unique identifier for the recording.", - "key": "recordingId" + "key": "recordingId", + "value": "" } ] } }, - "status": "No Content" - } - ] - }, - { - "name": "List Group Recordings", - "request": { - "description": "List group recordings for a service app which has group recording access. You can specify a date range, the maximum number of recordings to return, and `personId` or `hostEmail` of whom the recordings will be retrieved.\n\n* The list returned is sorted in descending order by the date and time that the recordings were created.\n\n* Only recordings which are in the `available` status and not shared by others can be listed. Those in the `deleted` or `purged` status or shared by others can't be listed.\n\n* Long result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the API lists group recordings on the specified site; otherwise, the API lists group recordings on all the sites managed by the service app. All the sites managed by a service app can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* One of the `personId` parameter and `hostEmail` header must be specified so that only recordings of meetings hosted by the person of `personId` or `hostEmail` will be returned.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.\n\n* `hostEmail`: Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" - }, - { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - } - ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" - } - }, - "response": [ + "status": "Service Unavailable" + }, { "_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": [ { @@ -97233,67 +101980,35 @@ ], "path": [ "group", - "recordings" + "recordings", + ":recordingId" ], "query": [ { "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", "key": "personId", "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", + "description": "A unique identifier for the recording.", + "key": "recordingId", "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" } - ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" + ] } }, - "status": "Method Not Allowed" + "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": [ { @@ -97314,78 +102029,37 @@ ], "path": [ "group", - "recordings" + "recordings", + ":recordingId" ], "query": [ { "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", "key": "personId", "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", + "description": "A unique identifier for the recording.", + "key": "recordingId", "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" } - ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" + ] } }, - "status": "Precondition Required" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"MeetingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"deleted\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"TrainingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"purged\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "body": "{\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"MeetingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"purged\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"temporaryDirectDownloadLinks\": {\n \"recordingDownloadLink\": \"\",\n \"audioDownloadLink\": \"\",\n \"transcriptDownloadLink\": \"\",\n \"expiration\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" } ], "name": "OK", @@ -97413,1119 +102087,687 @@ ], "path": [ "group", - "recordings" + "recordings", + ":recordingId" ], "query": [ { "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", "key": "personId", "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", + "variable": [ { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", + "description": "A unique identifier for the recording.", + "key": "recordingId", "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" } - ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" + ] } }, "status": "OK" + } + ] + }, + { + "name": "Share a Recording Link", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" }, + "description": "Share or unshare a recording with other users by recording link and email addresses.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "accessList" + ], + "raw": "{{baseUrl}}/recordings/accessList" + } + }, + "response": [ { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" + "recordings", + "accessList" ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" + "raw": "{{baseUrl}}/recordings/accessList" + } + }, + "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 \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" + "path": [ + "recordings", + "accessList" + ], + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Not Found" + "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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - } + "recordings", + "accessList" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Gone" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - } + "recordings", + "accessList" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Service Unavailable" + "status": "Not Found" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - } + "recordings", + "accessList" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Unauthorized" + "status": "Precondition Required" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - } + "recordings", + "accessList" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Conflict" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 410, "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": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - } + "recordings", + "accessList" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Internal Server Error" + "status": "Gone" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" + "recordings", + "accessList" ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" + "raw": "{{baseUrl}}/recordings/accessList" + } + }, + "status": "Unauthorized" + }, + { + "_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 \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "accessList" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Too Many Requests" + "status": "Gateway Timeout" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - } + "recordings", + "accessList" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Bad Gateway" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 502, "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 Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - } + "recordings", + "accessList" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Unsupported Media Type" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 415, "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": "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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - } + "recordings", + "accessList" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unsupported Media Type" }, { "_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": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - } + "recordings", + "accessList" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 204, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "No Content", "originalRequest": { - "header": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" - } + "recordings", + "accessList" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Bad Request" + "status": "No Content" }, { "_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": [ - { - "description": "e.g. UTC", - "key": "timezone", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", - "recordings" + "recordings", + "accessList" ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - }, - { - "description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", - "key": "max", - "value": "10" - }, - { - "description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.", - "key": "from", - "value": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time." - }, - { - "description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.", - "key": "to", - "value": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." - }, - { - "description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", - "key": "siteUrl", - "value": "" - }, - { - "description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".", - "key": "integrationTag", - "value": "" - }, - { - "description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.", - "key": "topic", - "value": "" - }, - { - "description": "Recording's file format. If specified, the API filters recordings by format.", - "key": "format", - "value": "ARF" - }, - { - "description": "The service type for recordings. If specified, the API filters recordings by service type.", - "key": "serviceType", - "value": "SupportCenter" + "raw": "{{baseUrl}}/recordings/accessList" + } + }, + "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 \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "recordings", + "accessList" ], - "raw": "{{baseUrl}}/group/recordings?personId=&max=10&from=If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time.&to=If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.&siteUrl=&integrationTag=&topic=&format=ARF&serviceType=SupportCenter" + "raw": "{{baseUrl}}/recordings/accessList" } }, - "status": "Gateway Timeout" + "status": "Bad Request" } ] }, { - "name": "Get Group Recording Details", + "name": "Query Recordings", "request": { - "description": "Retrieves details for a group recording for a service app which has group recording access.\n\n* Only recordings which are in the `available` status and not shared by others can be listed. Those in the `deleted` or `purged` status or shared by others can't be listed.\n\n* One of the `personId` parameter and `hostEmail` header must be specified so that only recordings of meetings hosted by the person of `personId` or `hostEmail` will be returned.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*\n\n* `hostEmail`: Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, + "description": "Queries recordings with filters in the request body. You can specify a date range, a parent meeting ID, the maximum number of recordings to return, and additional filters such as siteUrl, integrationTag, hostEmail, topic, format, serviceType, and status.\n\nOnly recordings of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. **NOTE**: when `meetingId` is specified, parameter of `siteUrl` will be ignored.\n\n* If `siteUrl` is specified, recordings of the specified site will be listed; otherwise, the API lists recordings of all the user's sites. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", "header": [ { "description": "e.g. UTC", @@ -98533,51 +102775,45 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" }, { "key": "Accept", "value": "application/json;charset=UTF-8" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, "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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -98585,48 +102821,42 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Gone" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 415, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. 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", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -98634,48 +102864,42 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Bad Gateway" + "status": "Unsupported Media Type" }, { "_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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -98683,48 +102907,42 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Precondition Required" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -98732,48 +102950,42 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Method Not Allowed" + "status": "Bad Request" }, { "_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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -98781,48 +102993,42 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Gateway Timeout" + "status": "Conflict" }, { "_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 \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -98830,48 +103036,42 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Conflict" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 504, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "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 \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -98879,48 +103079,42 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Forbidden" + "status": "Gateway Timeout" }, { "_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": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -98928,48 +103122,56 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Unauthorized" + "status": "Gone" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 423, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"MeetingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"deleted\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"EventCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"purged\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n }\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;charset=UTF-8" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -98977,48 +103179,46 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "OK" }, { "_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", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -99026,48 +103226,42 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Bad Request" + "status": "Not Found" }, { "_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", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -99075,48 +103269,42 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ - "{{baseUrl}}" - ], - "path": [ - "group", - "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } - ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "{{baseUrl}}" + ], + "path": [ + "recordings", + "query" + ], + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Not Found" + "status": "Method Not Allowed" }, { "_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": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -99124,48 +103312,42 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Unsupported Media Type" + "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", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -99173,48 +103355,42 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 428, "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": "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 \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -99222,39 +103398,23 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "Internal Server Error" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", @@ -99264,6 +103424,16 @@ "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 \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -99271,53 +103441,42 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"password\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"MeetingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"shareToMe\": \"\",\n \"status\": \"purged\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"temporaryDirectDownloadLinks\": {\n \"recordingDownloadLink\": \"\",\n \"audioDownloadLink\": \"\",\n \"transcriptDownloadLink\": \"\",\n \"expiration\": \"\"\n },\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 502, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json;charset=UTF-8" - } - ], - "name": "OK", + "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 \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"hostEmail\": \"\",\n \"topic\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"MeetingCenter\",\n \"status\": \"available\"\n}" + }, "header": [ { "description": "e.g. UTC", @@ -99325,48 +103484,28 @@ "value": "" }, { - "description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "hostEmail", - "value": "" - }, - { - "key": "Accept", - "value": "application/json;charset=UTF-8" + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "group", "recordings", - ":recordingId" - ], - "query": [ - { - "description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.", - "key": "personId", - "value": "" - } + "query" ], - "raw": "{{baseUrl}}/group/recordings/:recordingId?personId=", - "variable": [ - { - "description": "A unique identifier for the recording.", - "key": "recordingId", - "value": "" - } - ] + "raw": "{{baseUrl}}/recordings/query" } }, - "status": "OK" + "status": "Bad Gateway" } ] }, { - "name": "Share a Recording Link", + "name": "Query Recordings For an Admin or Compliance Officer", "request": { "body": { "mode": "raw", @@ -99376,13 +103515,22 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, - "description": "Share or unshare a recording with other users by recording link and email addresses.", + "description": "Queries recordings for an admin or compliance officer with filters in the request body. You can specify a date range, a parent meeting ID, the maximum number of recordings to return, and additional filters such as siteUrl, integrationTag, topic, format, serviceType, and status.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. Please note that when `meetingId` is specified, parameters of `siteUrl`, `from`, and `to` will be ignored.\n\n* If `siteUrl` is specified, all the recordings on the specified site are listed; otherwise, all the recordings on the admin user's or compliance officer's preferred site are listed. All the available Webex sites and the admin user's or compliance officer's preferred site can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*", "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], "method": "POST", @@ -99391,20 +103539,21 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, "response": [ { "_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", @@ -99414,9 +103563,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -99428,21 +103582,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Forbidden" + "status": "Bad Gateway" }, { "_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", @@ -99452,9 +103607,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -99466,21 +103626,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Conflict" + "status": "Gateway Timeout" }, { "_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", @@ -99490,9 +103651,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -99504,21 +103670,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 415, "cookie": [], "header": [], - "name": "Not Found", + "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", @@ -99528,9 +103695,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -99542,21 +103714,36 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Not Found" + "status": "Unsupported Media Type" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 428, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"format\": \"UPLOADED\",\n \"serviceType\": \"MeetingCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"status\": \"deleted\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"meetingId\": \"\",\n \"topic\": \"\",\n \"createTime\": \"\",\n \"timeRecorded\": \"\",\n \"hostDisplayName\": \"\",\n \"hostEmail\": \"\",\n \"siteUrl\": \"\",\n \"downloadUrl\": \"\",\n \"playbackUrl\": \"\",\n \"format\": \"ARF\",\n \"serviceType\": \"EventCenter\",\n \"durationSeconds\": \"\",\n \"sizeBytes\": \"\",\n \"status\": \"purged\",\n \"scheduledMeetingId\": \"\",\n \"meetingSeriesId\": \"\",\n \"integrationTags\": [\n \"\",\n \"\"\n ]\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;charset=UTF-8" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -99566,12 +103753,21 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json;charset=UTF-8" } ], "method": "POST", @@ -99580,21 +103776,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Precondition Required" + "status": "OK" }, { "_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", @@ -99604,9 +103801,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -99618,21 +103820,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_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", @@ -99642,9 +103845,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -99656,21 +103864,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "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": { "body": { "mode": "raw", @@ -99680,9 +103889,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -99694,21 +103908,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_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": { "body": { "mode": "raw", @@ -99718,9 +103933,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -99732,21 +103952,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Gateway Timeout" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 401, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "body": { "mode": "raw", @@ -99756,9 +103977,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -99770,21 +103996,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Method Not Allowed" + "status": "Unauthorized" }, { "_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": { "body": { "mode": "raw", @@ -99794,9 +104021,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -99808,21 +104040,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Bad Gateway" + "status": "Method Not Allowed" }, { "_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", @@ -99832,9 +104065,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -99846,21 +104084,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Unsupported Media Type" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 503, "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": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -99870,9 +104109,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -99884,21 +104128,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Too Many Requests" + "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": { "body": { "mode": "raw", @@ -99908,9 +104153,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -99922,21 +104172,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "No Content" + "status": "Internal Server Error" }, { "_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": { "body": { "mode": "raw", @@ -99946,9 +104197,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -99960,21 +104216,22 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Service Unavailable" + "status": "Precondition Required" }, { "_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": { "body": { "mode": "raw", @@ -99984,9 +104241,14 @@ "language": "json" } }, - "raw": "{\n \"hostEmail\": \"\",\n \"webShareLink\": \"\",\n \"addEmails\": [\n \"\",\n \"\"\n ],\n \"removeEmails\": [\n \"\",\n \"\"\n ],\n \"sendEmail\": \"\"\n}" + "raw": "{\n \"max\": 10,\n \"from\": \"\",\n \"to\": \"\",\n \"meetingId\": \"\",\n \"siteUrl\": \"\",\n \"integrationTag\": \"\",\n \"topic\": \"\",\n \"format\": \"MP4\",\n \"serviceType\": \"SupportCenter\",\n \"status\": \"available\",\n \"timezone\": \"\"\n}" }, "header": [ + { + "description": "e.g. UTC", + "key": "timezone", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -99998,13 +104260,14 @@ "{{baseUrl}}" ], "path": [ + "admin", "recordings", - "accessList" + "query" ], - "raw": "{{baseUrl}}/recordings/accessList" + "raw": "{{baseUrl}}/admin/recordings/query" } }, - "status": "Bad Request" + "status": "Forbidden" } ] } diff --git a/codegen/postman/Webex Messaging.postman_collection.json b/codegen/postman/Webex Messaging.postman_collection.json index 42f2d1b..14ddcc0 100644 --- a/codegen/postman/Webex Messaging.postman_collection.json +++ b/codegen/postman/Webex Messaging.postman_collection.json @@ -15606,7 +15606,7 @@ }, "raw": "{\n \"displayName\": \"\",\n \"emails\": [\n \"\",\n \"\"\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"\"\n },\n {\n \"type\": \"work\",\n \"value\": \"\"\n }\n ],\n \"extension\": \"\",\n \"locationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"nickName\": \"\",\n \"avatar\": \"\",\n \"orgId\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"licenses\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"manager\": \"\",\n \"managerId\": \"\",\n \"title\": \"\",\n \"addresses\": [\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n },\n {\n \"type\": \"\",\n \"country\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"streetAddress\": \"\",\n \"postalCode\": \"\"\n }\n ],\n \"siteUrls\": [\n \"\",\n \"\"\n ],\n \"loginEnabled\": \"\"\n}" }, - "description": "Update details for a person, by ID.\n\nSpecify the person ID in the `personId` parameter in the URI. Only an admin can update a person details.\n\nInclude all details for the person. This action expects all user details to be present in the request. A common approach is to first [GET the person's details](/docs/api/v1/people/get-person-details), make changes, then PUT both the changed and unchanged values.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.\n\nWhen doing attendee management, to update a user from host role to an attendee for a site append `#attendee` to the respective `siteUrl` and remove the meeting host license for this site from the license array.\nTo update a person from an attendee role to a host for a site, add the meeting license for this site in the meeting array, and remove that site from the `siteurl` parameter.\n\nTo remove the attendee privilege for a user on a meeting site, remove the `sitename#attendee` from the `siteUrl`s array. The `showAllTypes` parameter must be set to `true`.\n\n**NOTE**:\n\n* The `locationId` can only be set when assigning a calling license to a user. It cannot be changed if a user is already an existing calling user.\n\n* The `extension` field should be used to update the Webex Calling extension for a person. The extension value should not include the location routing prefix. The `work_extension` type in the `phoneNumbers` object as seen in the response payload of [List People](/docs/api/v1/people/list-people) or [Get Person Details](/docs/api/v1/people/get-person-details), cannot be used to set the Webex Calling extension for a person.\n\n* When updating a user with multiple email addresses using a PUT request, ensure that the primary email address is listed first in the array. Note that the order of email addresses returned by a GET request is not guaranteed..\n\n* The People API is a combination of several microservices, each responsible for specific attributes of a person. As a result, a PUT request that returns an error response code may still have altered some values of the person's data. Therefore, it is recommended to perform a GET request after encountering an error to verify the current state of the resource. \n\n* Some licenses are implicitly assigned by the system and cannot be admin controlled. They are necessary for the baseline function of the Webex system. If you get an error about implicitly assigned licensed that cannot be removed, please ensure you have the corresponding license in your PUT request.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.", + "description": "Update details for a person, by ID.\n\nSpecify the person ID in the `personId` parameter in the URI. Only an admin can update a person details.\n\nInclude all details for the person. This action expects all user details to be present in the request. A common approach is to first [GET the person's details](/docs/api/v1/people/get-person-details), make changes, then PUT both the changed and unchanged values.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.\n\nWhen doing attendee management, to update a user from host role to an attendee for a site append `#attendee` to the respective `siteUrl` and remove the meeting host license for this site from the license array.\nTo update a person from an attendee role to a host for a site, add the meeting license for this site in the meeting array, and remove that site from the `siteurl` parameter.\n\nTo remove the attendee privilege for a user on a meeting site, remove the `sitename#attendee` from the `siteUrl`s array. The `showAllTypes` parameter must be set to `true`.\n\n**NOTE**:\n\n* When assigning a Webex Calling license, either a telephone number or extension must already be assigned to the person or provided in the request payload.\n\n* When `callingData` is set to `true`, a Webex Calling license must be included in the `licenses` array.\n\n* The `locationId` can only be set when assigning a calling license to a user. It cannot be changed if a user is already an existing calling user.\n\n* The `extension` field should be used to update the Webex Calling extension for a person. The extension value should not include the location routing prefix. The `work_extension` type in the `phoneNumbers` object as seen in the response payload of [List People](/docs/api/v1/people/list-people) or [Get Person Details](/docs/api/v1/people/get-person-details), cannot be used to set the Webex Calling extension for a person.\n\n* When updating a user with multiple email addresses using a PUT request, ensure that the primary email address is listed first in the array. Note that the order of email addresses returned by a GET request is not guaranteed..\n\n* The People API is a combination of several microservices, each responsible for specific attributes of a person. As a result, a PUT request that returns an error response code may still have altered some values of the person's data. Therefore, it is recommended to perform a GET request after encountering an error to verify the current state of the resource. \n\n* Some licenses are implicitly assigned by the system and cannot be admin controlled. They are necessary for the baseline function of the Webex system. If you get an error about implicitly assigned licensed that cannot be removed, please ensure you have the corresponding license in your PUT request.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.", "header": [ { "key": "Content-Type", @@ -33988,7 +33988,7 @@ "code": 400, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or could not be otherwise processed. An accompanying error message will provide more details.", + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", "originalRequest": { "header": [], "method": "GET", @@ -34148,7 +34148,7 @@ "code": 428, "cookie": [], "header": [], - "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force-downloaded.", + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -34304,7 +34304,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"orgId\": \"\",\n \"items\": [\n {\n \"clusters\": {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"hostname\": \"\",\n \"hostIp\": \"\",\n \"testResults\": [\n {\n \"triggerType\": \"\",\n \"results\": [\n {\n \"timestamp\": \"\",\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"timestamp\": \"\",\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"triggerType\": \"\",\n \"results\": [\n {\n \"timestamp\": \"\",\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"timestamp\": \"\",\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"nodeId\": \"\",\n \"hostname\": \"\",\n \"hostIp\": \"\",\n \"testResults\": [\n {\n \"triggerType\": \"\",\n \"results\": [\n {\n \"timestamp\": \"\",\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"timestamp\": \"\",\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"triggerType\": \"\",\n \"results\": [\n {\n \"timestamp\": \"\",\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"timestamp\": \"\",\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n },\n {\n \"clusters\": {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"hostname\": \"\",\n \"hostIp\": \"\",\n \"testResults\": [\n {\n \"triggerType\": \"\",\n \"results\": [\n {\n \"timestamp\": \"\",\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"timestamp\": \"\",\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"triggerType\": \"\",\n \"results\": [\n {\n \"timestamp\": \"\",\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"timestamp\": \"\",\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"nodeId\": \"\",\n \"hostname\": \"\",\n \"hostIp\": \"\",\n \"testResults\": [\n {\n \"triggerType\": \"\",\n \"results\": [\n {\n \"timestamp\": \"\",\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"timestamp\": \"\",\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"triggerType\": \"\",\n \"results\": [\n {\n \"timestamp\": \"\",\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"timestamp\": \"\",\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n }\n ]\n}", + "body": "{\n \"context\": {\n \"orgId\": \"\",\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodeId\": \"\",\n \"hostName\": \"\",\n \"hostIP\": \"\"\n },\n \"testResults\": [\n {\n \"timestamp\": \"\",\n \"triggerType\": \"\",\n \"result\": [\n {\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n }\n ]\n },\n {\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"timestamp\": \"\",\n \"triggerType\": \"\",\n \"result\": [\n {\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n }\n ]\n },\n {\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -34511,7 +34511,7 @@ "code": 400, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or could not be otherwise processed. An accompanying error message will provide more details.", + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", "originalRequest": { "header": [], "method": "GET", @@ -34573,7 +34573,7 @@ "code": 428, "cookie": [], "header": [], - "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force-downloaded.", + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -34910,7 +34910,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"orgId\": \"\",\n \"clusters\": [\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"host\": \"\"\n },\n {\n \"nodeId\": \"\",\n \"host\": \"\"\n }\n ],\n \"releaseChannel\": \"\",\n \"upgradeSchedule\": {\n \"scheduleDays\": [\n \"\",\n \"\"\n ],\n \"scheduleTime\": \"\",\n \"scheduleTimeZone\": \"\",\n \"nextUpgradeTime\": \"\"\n },\n \"clusterStatus\": \"\"\n },\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"host\": \"\"\n },\n {\n \"nodeId\": \"\",\n \"host\": \"\"\n }\n ],\n \"releaseChannel\": \"\",\n \"upgradeSchedule\": {\n \"scheduleDays\": [\n \"\",\n \"\"\n ],\n \"scheduleTime\": \"\",\n \"scheduleTimeZone\": \"\",\n \"nextUpgradeTime\": \"\"\n },\n \"clusterStatus\": \"\"\n }\n ]\n },\n {\n \"orgId\": \"\",\n \"clusters\": [\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"host\": \"\"\n },\n {\n \"nodeId\": \"\",\n \"host\": \"\"\n }\n ],\n \"releaseChannel\": \"\",\n \"upgradeSchedule\": {\n \"scheduleDays\": [\n \"\",\n \"\"\n ],\n \"scheduleTime\": \"\",\n \"scheduleTimeZone\": \"\",\n \"nextUpgradeTime\": \"\"\n },\n \"clusterStatus\": \"\"\n },\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"host\": \"\"\n },\n {\n \"nodeId\": \"\",\n \"host\": \"\"\n }\n ],\n \"releaseChannel\": \"\",\n \"upgradeSchedule\": {\n \"scheduleDays\": [\n \"\",\n \"\"\n ],\n \"scheduleTime\": \"\",\n \"scheduleTimeZone\": \"\",\n \"nextUpgradeTime\": \"\"\n },\n \"clusterStatus\": \"\"\n }\n ]\n }\n ]\n}", + "body": "{\n \"context\": {\n \"orgId\": \"\"\n },\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"clusterStatus\": \"\",\n \"releaseChannel\": \"\",\n \"upgradeSchedule\": {\n \"scheduleDays\": [\n \"\",\n \"\"\n ],\n \"scheduleTime\": \"\",\n \"scheduleTimeZone\": \"\",\n \"nextUpgradeTime\": \"\"\n }\n}", "code": 200, "cookie": [], "header": [ @@ -35016,7 +35016,7 @@ { "name": "Get organization details", "request": { - "description": "Retrieve details for an HDS organization, such as the organization name, type of organization, and clusters in the organization.\nTo obtain the Organization ID needed for this API, use the [Organizations API]()", + "description": "Retrieve details for an HDS organization, such as the organization name, type of organization.\nTo obtain the Organization ID needed for this API, use the [Organizations API]()", "header": [ { "key": "Accept", @@ -35236,7 +35236,7 @@ "code": 428, "cookie": [], "header": [], - "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force-downloaded.", + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -35325,7 +35325,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"orgId\": \"\",\n \"orgName\": \"\",\n \"orgType\": \"\",\n \"orgMode\": \"\",\n \"clusters\": [\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\"\n },\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\"\n }\n ]\n },\n {\n \"orgId\": \"\",\n \"orgName\": \"\",\n \"orgType\": \"\",\n \"orgMode\": \"\",\n \"clusters\": [\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\"\n },\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\"\n }\n ]\n }\n ]\n}", + "body": "{\n \"orgId\": \"\",\n \"orgName\": \"\",\n \"orgType\": \"\",\n \"orgMode\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -35370,7 +35370,7 @@ "code": 400, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or could not be otherwise processed. An accompanying error message will provide more details.", + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", "originalRequest": { "header": [], "method": "GET", @@ -35682,7 +35682,7 @@ "code": 428, "cookie": [], "header": [], - "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force-downloaded.", + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -35775,7 +35775,7 @@ "code": 400, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or could not be otherwise processed. An accompanying error message will provide more details.", + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", "originalRequest": { "header": [], "method": "GET", @@ -35957,7 +35957,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"orgId\": \"\",\n \"clusters\": [\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n },\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n }\n ]\n },\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n },\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"orgId\": \"\",\n \"clusters\": [\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n },\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n }\n ]\n },\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n },\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n }\n ]\n }\n ]\n }\n ]\n}", + "body": "{\n \"context\": {\n \"orgId\": \"\",\n \"clusterId\": \"\",\n \"clusterName\": \"\"\n },\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -37314,7 +37314,7 @@ "code": 428, "cookie": [], "header": [], - "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force-downloaded.", + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -37402,7 +37402,7 @@ "code": 400, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or could not be otherwise processed. An accompanying error message will provide more details.", + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", "originalRequest": { "header": [], "method": "GET", @@ -37662,7 +37662,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"orgId\": \"\",\n \"clusters\": [\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"availabilitySegments\": [\n {\n \"segmentStartTime\": \"\",\n \"segmentEndTime\": \"\",\n \"onlineNodeCount\": \"\",\n \"offlineNodeCount\": \"\",\n \"totalNodeCount\": \"\"\n },\n {\n \"segmentStartTime\": \"\",\n \"segmentEndTime\": \"\",\n \"onlineNodeCount\": \"\",\n \"offlineNodeCount\": \"\",\n \"totalNodeCount\": \"\"\n }\n ]\n },\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"availabilitySegments\": [\n {\n \"segmentStartTime\": \"\",\n \"segmentEndTime\": \"\",\n \"onlineNodeCount\": \"\",\n \"offlineNodeCount\": \"\",\n \"totalNodeCount\": \"\"\n },\n {\n \"segmentStartTime\": \"\",\n \"segmentEndTime\": \"\",\n \"onlineNodeCount\": \"\",\n \"offlineNodeCount\": \"\",\n \"totalNodeCount\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"orgId\": \"\",\n \"clusters\": [\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"availabilitySegments\": [\n {\n \"segmentStartTime\": \"\",\n \"segmentEndTime\": \"\",\n \"onlineNodeCount\": \"\",\n \"offlineNodeCount\": \"\",\n \"totalNodeCount\": \"\"\n },\n {\n \"segmentStartTime\": \"\",\n \"segmentEndTime\": \"\",\n \"onlineNodeCount\": \"\",\n \"offlineNodeCount\": \"\",\n \"totalNodeCount\": \"\"\n }\n ]\n },\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"availabilitySegments\": [\n {\n \"segmentStartTime\": \"\",\n \"segmentEndTime\": \"\",\n \"onlineNodeCount\": \"\",\n \"offlineNodeCount\": \"\",\n \"totalNodeCount\": \"\"\n },\n {\n \"segmentStartTime\": \"\",\n \"segmentEndTime\": \"\",\n \"onlineNodeCount\": \"\",\n \"offlineNodeCount\": \"\",\n \"totalNodeCount\": \"\"\n }\n ]\n }\n ]\n }\n ]\n}", + "body": "{\n \"context\": {\n \"orgId\": \"\",\n \"clusterId\": \"\",\n \"clusterName\": \"\"\n },\n \"availabilitySegments\": [\n {\n \"segmentStartTime\": \"\",\n \"segmentEndTime\": \"\",\n \"noOfOnlineNodes\": \"\",\n \"noOfOfflineNodes\": \"\",\n \"totalNodes\": \"\"\n },\n {\n \"segmentStartTime\": \"\",\n \"segmentEndTime\": \"\",\n \"noOfOnlineNodes\": \"\",\n \"noOfOfflineNodes\": \"\",\n \"totalNodes\": \"\"\n }\n ],\n \"timeRange\": {\n \"from\": \"\",\n \"to\": \"\"\n }\n}", "code": 200, "cookie": [], "header": [ @@ -38050,7 +38050,7 @@ "code": 428, "cookie": [], "header": [], - "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force-downloaded.", + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -38412,7 +38412,7 @@ "code": 400, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or could not be otherwise processed. An accompanying error message will provide more details.", + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", "originalRequest": { "header": [], "method": "GET", @@ -38712,7 +38712,7 @@ "code": 400, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or could not be otherwise processed. An accompanying error message will provide more details.", + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", "originalRequest": { "header": [], "method": "GET", @@ -39032,7 +39032,7 @@ "code": 428, "cookie": [], "header": [], - "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force-downloaded.", + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -39091,9 +39091,9459 @@ "status": "Bad Gateway" } ] - } - ], - "name": "HDS" + }, + { + "name": "List nodes for an HDS cluster", + "request": { + "description": "Retrieve a list of all nodes for a specific HDS cluster, including availability, proxy details, deployment type, and release version.\nTo obtain the Cluster ID needed for this API, use the [List clusters for an HDS organization API]()", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"nodes\": [\n {\n \"items\": [\n {\n \"orgId\": \"\",\n \"clusters\": [\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n },\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n }\n ]\n },\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n },\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"orgId\": \"\",\n \"clusters\": [\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n },\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n }\n ]\n },\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n },\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"items\": [\n {\n \"orgId\": \"\",\n \"clusters\": [\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n },\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n }\n ]\n },\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n },\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"orgId\": \"\",\n \"clusters\": [\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n },\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n }\n ]\n },\n {\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodes\": [\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n },\n {\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n }\n ]\n }\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": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "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, please contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "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 period 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": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "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 with a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "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": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "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 method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "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 to indicate how many seconds you should wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "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": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "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": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request was understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the HDS cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + } + ] + }, + { + "name": "List clusters for an HDS organization", + "request": { + "description": "Retrieve a list of all clusters for a specific HDS organization, including cluster status, release channel, and upgrade schedule details.\nTo obtain the Organization ID needed for this API, use the [Organizations API]()", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given period 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": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "The request was invalid or could not be processed. An accompanying error message will provide more details.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"clusters\": [\n {\n \"context\": {\n \"orgId\": \"\"\n },\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"clusterStatus\": \"\",\n \"releaseChannel\": \"\",\n \"upgradeSchedule\": {\n \"scheduleDays\": [\n \"\",\n \"\"\n ],\n \"scheduleTime\": \"\",\n \"scheduleTimeZone\": \"\",\n \"nextUpgradeTime\": \"\"\n }\n },\n {\n \"context\": {\n \"orgId\": \"\"\n },\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"clusterStatus\": \"\",\n \"releaseChannel\": \"\",\n \"upgradeSchedule\": {\n \"scheduleDays\": [\n \"\",\n \"\"\n ],\n \"scheduleTime\": \"\",\n \"scheduleTimeZone\": \"\",\n \"nextUpgradeTime\": \"\"\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": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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 with a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_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": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request was understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "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": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present to indicate how many seconds you should wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "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, please contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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 method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "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": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the HDS organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + } + ] + }, + { + "name": "Get alarms for an HDS node", + "request": { + "description": "Returns the alarm details for a single HDS node for the provided time range (last 24 hours).\nTo obtain the Node ID needed for this API, use the [List nodes for an HDS cluster API]()", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given period 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": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_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": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_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": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, please contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present to indicate how many seconds you should wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "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": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "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 with a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"context\": {\n \"orgId\": \"\",\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodeId\": \"\",\n \"host\": \"\"\n },\n \"alarms\": [\n {\n \"alarmId\": \"\",\n \"alarmName\": \"\",\n \"alarmSeverity\": \"\",\n \"alarmDetails\": \"\",\n \"possibleRemediation\": \"\",\n \"currentStatus\": \"\",\n \"occurrences\": {\n \"total\": \"\",\n \"details\": [\n {\n \"raisedAt\": \"\",\n \"clearedAt\": \"\"\n },\n {\n \"raisedAt\": \"\",\n \"clearedAt\": \"\"\n }\n ]\n }\n },\n {\n \"alarmId\": \"\",\n \"alarmName\": \"\",\n \"alarmSeverity\": \"\",\n \"alarmDetails\": \"\",\n \"possibleRemediation\": \"\",\n \"currentStatus\": \"\",\n \"occurrences\": {\n \"total\": \"\",\n \"details\": [\n {\n \"raisedAt\": \"\",\n \"clearedAt\": \"\"\n },\n {\n \"raisedAt\": \"\",\n \"clearedAt\": \"\"\n }\n ]\n }\n }\n ],\n \"timeRange\": {\n \"from\": \"\",\n \"to\": \"\"\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": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "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": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request was understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "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 method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + } + ] + }, + { + "name": "Get resource usage for an HDS node", + "request": { + "description": "Retrieve CPU, memory, and disk resource usage details for a specific HDS node over the requested time range.\nTo obtain the Node ID needed for this API, use the [List nodes for an HDS cluster API]()", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "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 to indicate how many seconds you should wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"context\": {\n \"orgId\": \"\",\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodeId\": \"\",\n \"host\": \"\"\n },\n \"resourceUsage\": [\n {\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"cpuUsage\": {\n \"peakCpuUsagePercent\": \"\",\n \"averageCpuUsagePercent\": \"\"\n },\n \"memoryUsage\": {\n \"totalMemoryUsageInMB\": \"\",\n \"peakMemoryUsageInMB\": \"\",\n \"peakMemoryUsagePercent\": \"\",\n \"averageMemoryUsageInMB\": \"\",\n \"averageMemoryUsagePercent\": \"\"\n },\n \"diskUsage\": {\n \"totalDiskSpaceUsageInMB\": \"\",\n \"peakDiskSpaceUsageInMB\": \"\",\n \"peakDiskUsagePercent\": \"\",\n \"averageDiskUsage\": \"\",\n \"averageDiskUsagePercent\": \"\"\n }\n },\n {\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"cpuUsage\": {\n \"peakCpuUsagePercent\": \"\",\n \"averageCpuUsagePercent\": \"\"\n },\n \"memoryUsage\": {\n \"totalMemoryUsageInMB\": \"\",\n \"peakMemoryUsageInMB\": \"\",\n \"peakMemoryUsagePercent\": \"\",\n \"averageMemoryUsageInMB\": \"\",\n \"averageMemoryUsagePercent\": \"\"\n },\n \"diskUsage\": {\n \"totalDiskSpaceUsageInMB\": \"\",\n \"peakDiskSpaceUsageInMB\": \"\",\n \"peakDiskUsagePercent\": \"\",\n \"averageDiskUsage\": \"\",\n \"averageDiskUsagePercent\": \"\"\n }\n }\n ],\n \"timeRange\": {\n \"from\": \"\",\n \"to\": \"\"\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": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_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": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_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": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "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 method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "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, please contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "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 with a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "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 period 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": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_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": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_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": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request was understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the HDS node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + } + ] + } + ], + "name": "HDS" + }, + { + "item": [ + { + "name": "Get organization details", + "request": { + "description": "Retrieve details for an Hybrid Data Security organization, such as the organization name, type of organization.\nTo obtain the Organization ID needed for this API, use the [Organizations API]()", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "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 with a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "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 method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_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": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, please contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "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 to indicate how many seconds you should wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"orgId\": \"\",\n \"orgName\": \"\",\n \"orgType\": \"\",\n \"orgMode\": \"\"\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": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request was understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "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": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "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 period 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": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + } + ] + }, + { + "name": "List clusters for an Hybrid Data Security organization", + "request": { + "description": "Retrieve a list of all clusters for a specific Hybrid Data Security organization, including cluster status, release channel, and upgrade schedule details.\nTo obtain the Organization ID needed for this API, use the [Organizations API]()", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "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 with a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "The request was invalid or could not be processed. An accompanying error message will provide more details.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present to indicate how many seconds you should wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "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, please contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request was understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"clusters\": [\n {\n \"context\": {\n \"orgId\": \"\"\n },\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"clusterStatus\": \"\",\n \"releaseChannel\": \"\",\n \"upgradeSchedule\": {\n \"scheduleDays\": [\n \"\",\n \"\"\n ],\n \"scheduleTime\": \"\",\n \"scheduleTimeZone\": \"\",\n \"nextUpgradeTime\": \"\"\n }\n },\n {\n \"context\": {\n \"orgId\": \"\"\n },\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"clusterStatus\": \"\",\n \"releaseChannel\": \"\",\n \"upgradeSchedule\": {\n \"scheduleDays\": [\n \"\",\n \"\"\n ],\n \"scheduleTime\": \"\",\n \"scheduleTimeZone\": \"\",\n \"nextUpgradeTime\": \"\"\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": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "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 period 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": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "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 method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "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": [ + "hds", + "organizations", + ":organizationId", + "clusters" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/clusters", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + } + ] + }, + { + "name": "Get cluster details", + "request": { + "description": "Retrieve details for a specific Hybrid Data Security cluster, such as the cluster name, cluster status, upgrade schedule, and Hybrid Data Security nodes in the cluster.\nTo obtain the Cluster ID needed for this API, use the [Get organization details API]()", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "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": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "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 with a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "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": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "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 method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "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": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_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": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present to indicate how many seconds you should wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request was understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "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, please contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "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 period 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": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_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": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"context\": {\n \"orgId\": \"\"\n },\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"clusterStatus\": \"\",\n \"releaseChannel\": \"\",\n \"upgradeSchedule\": {\n \"scheduleDays\": [\n \"\",\n \"\"\n ],\n \"scheduleTime\": \"\",\n \"scheduleTimeZone\": \"\",\n \"nextUpgradeTime\": \"\"\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": [ + "hds", + "clusters", + ":clusterId" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "OK" + } + ] + }, + { + "name": "List nodes for an Hybrid Data Security cluster", + "request": { + "description": "Retrieve a list of all nodes for a specific Hybrid Data Security cluster, including availability, proxy details, deployment type, and release version.\nTo obtain the Cluster ID needed for this API, use the [List clusters for an Hybrid Data Security organization API]()", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given period 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": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "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 with a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "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 method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "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 to indicate how many seconds you should wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"nodes\": [\n {\n \"context\": {\n \"orgId\": \"\",\n \"clusterId\": \"\",\n \"clusterName\": \"\"\n },\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\n },\n {\n \"context\": {\n \"orgId\": \"\",\n \"clusterId\": \"\",\n \"clusterName\": \"\"\n },\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\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": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "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": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "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, please contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request was understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_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": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "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": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "nodes" + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/nodes", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + } + ] + }, + { + "name": "Get node details", + "request": { + "description": "Retrieve details for a specific Hybrid Data Security node, such as host name, release version, proxy details, deployment and build type, availability details, etc.\nTo obtain the Node ID needed for this API, use the [Get cluster details API]()", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"context\": {\n \"orgId\": \"\",\n \"clusterId\": \"\",\n \"clusterName\": \"\"\n },\n \"nodeId\": \"\",\n \"host\": \"\",\n \"availabilityDetails\": {\n \"nodeAvailability\": \"\",\n \"hdsHealthStatus\": \"\",\n \"hdsUnhealthyReasons\": [\n \"\",\n \"\"\n ]\n },\n \"releaseVersion\": \"\",\n \"proxyType\": \"\",\n \"proxyStatus\": \"\",\n \"maintenanceMode\": \"\",\n \"ntpSync\": \"\",\n \"ovaDeploymentType\": \"\",\n \"ovaBuildType\": \"\"\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": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "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, please contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "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 to indicate how many seconds you should wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "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 with a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_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": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request was understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "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": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "value": "" + } + ] + } + }, + "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": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "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 period 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": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "value": "" + } + ] + } + }, + "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": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "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 method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId" + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + } + ] + }, + { + "name": "Get database details for the Hybrid Data Security organization", + "request": { + "description": "Retrieve details of database information for an Hybrid Data Security organization, such as database type and version used.\nTo obtain the Organization ID needed for this API, use the [Organizations API]()", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "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 to indicate how many seconds you should wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "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, please contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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 method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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 with a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"context\": {\n \"orgId\": \"\"\n },\n \"databaseType\": \"\",\n \"databaseVersion\": \"\"\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": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "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": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "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": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "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 period 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": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request was understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "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": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_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": [ + "hds", + "organizations", + ":organizationId", + "database" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/database", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Conflict" + } + ] + }, + { + "name": "Get Multi-Tenant Hybrid Data Security organization details", + "request": { + "description": "Retrieve details of Multi-Tenant Hybrid Data Security organization such as Organization Name and ID, CMK state and state of Tenants Organizations.\nTo obtain the Organization ID needed for this API, use the [Organizations API]()", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, please contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "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 period 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": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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 with a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request was understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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 method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "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 to indicate how many seconds you should wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"context\": {\n \"partnerOrgId\": \"\"\n },\n \"tenants\": [\n {\n \"tenantOrgId\": \"\",\n \"tenantOrgName\": \"\",\n \"cmkState\": \"\",\n \"tenantOrgState\": \"\"\n },\n {\n \"tenantOrgId\": \"\",\n \"tenantOrgName\": \"\",\n \"cmkState\": \"\",\n \"tenantOrgState\": \"\"\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": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "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": [ + "hds", + "organizations", + ":organizationId", + "tenants" + ], + "raw": "{{baseUrl}}/hds/organizations/:organizationId/tenants", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security organization.", + "key": "organizationId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + } + ] + }, + { + "name": "Get alarms for an Hybrid Data Security node", + "request": { + "description": "Returns the alarm details for a single Hybrid Data Security node for the provided time range (last 24 hours).\nTo obtain the Node ID needed for this API, use the [List nodes for an Hybrid Data Security cluster API]()", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "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 method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present to indicate how many seconds you should wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "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": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given period 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": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"context\": {\n \"orgId\": \"\",\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodeId\": \"\",\n \"host\": \"\"\n },\n \"alarms\": [\n {\n \"alarmId\": \"\",\n \"alarmName\": \"\",\n \"alarmSeverity\": \"\",\n \"alarmDetails\": \"\",\n \"possibleRemediation\": \"\",\n \"currentStatus\": \"\",\n \"occurrences\": {\n \"total\": \"\",\n \"details\": [\n {\n \"raisedAt\": \"\",\n \"clearedAt\": \"\"\n },\n {\n \"raisedAt\": \"\",\n \"clearedAt\": \"\"\n }\n ]\n }\n },\n {\n \"alarmId\": \"\",\n \"alarmName\": \"\",\n \"alarmSeverity\": \"\",\n \"alarmDetails\": \"\",\n \"possibleRemediation\": \"\",\n \"currentStatus\": \"\",\n \"occurrences\": {\n \"total\": \"\",\n \"details\": [\n {\n \"raisedAt\": \"\",\n \"clearedAt\": \"\"\n },\n {\n \"raisedAt\": \"\",\n \"clearedAt\": \"\"\n }\n ]\n }\n }\n ],\n \"timeRange\": {\n \"from\": \"\",\n \"to\": \"\"\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": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_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 with a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request was understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "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": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "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": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "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, please contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "alarms" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/alarms?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + } + ] + }, + { + "name": "Get test results for Hybrid Data Security node", + "request": { + "description": "Get the latest results of the network tests triggered for a single Hybrid Data Security node. The test results are generated as part of the Network Test execution on the node. The network tests include the Bandwidth Test, DNS Resolution Test, and HTTPS Connectivity Test.\n The results from the latest test run are provided, covering up to the past 90 days if available.\nTo obtain the Node ID needed for this API, use the [Get cluster details API]()", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_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": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "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 with a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, please contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "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": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_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": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request was understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given period 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": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "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 to indicate how many seconds you should wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"context\": {\n \"orgId\": \"\",\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodeId\": \"\",\n \"hostName\": \"\",\n \"hostIP\": \"\"\n },\n \"testResults\": [\n {\n \"timestamp\": \"\",\n \"triggerType\": \"\",\n \"result\": [\n {\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n }\n ]\n },\n {\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"timestamp\": \"\",\n \"triggerType\": \"\",\n \"result\": [\n {\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n }\n ]\n },\n {\n \"type\": \"\",\n \"results\": [\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n },\n {\n \"serviceType\": \"\",\n \"services\": [\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"serviceName\": \"\",\n \"testResult\": \"\",\n \"failureDetails\": {\n \"possibleFailureReason\": [\n \"\",\n \"\"\n ],\n \"possibleRemediation\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n }\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": [ + "hds", + "testResults", + "nodes", + ":nodeId", + "networkTest" + ], + "query": [ + { + "description": "Trigger type.", + "key": "triggerType", + "value": "OnDemand" + } + ], + "raw": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest?triggerType=OnDemand", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "OK" + } + ] + }, + { + "name": "Get resource usage for an Hybrid Data Security node", + "request": { + "description": "Retrieve CPU, memory, and disk resource usage details for a specific Hybrid Data Security node over the requested time range.\nTo obtain the Node ID needed for this API, use the [List nodes for an Hybrid Data Security cluster API]()", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request was understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given period 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": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_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": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "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 method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "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, please contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "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 with a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "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": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"context\": {\n \"orgId\": \"\",\n \"clusterId\": \"\",\n \"clusterName\": \"\",\n \"nodeId\": \"\",\n \"host\": \"\"\n },\n \"resourceUsage\": [\n {\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"cpuUsage\": {\n \"peakCpuUsagePercent\": \"\",\n \"averageCpuUsagePercent\": \"\"\n },\n \"memoryUsage\": {\n \"totalMemoryUsageInMB\": \"\",\n \"peakMemoryUsageInMB\": \"\",\n \"peakMemoryUsagePercent\": \"\",\n \"averageMemoryUsageInMB\": \"\",\n \"averageMemoryUsagePercent\": \"\"\n },\n \"diskUsage\": {\n \"totalDiskSpaceUsageInMB\": \"\",\n \"peakDiskSpaceUsageInMB\": \"\",\n \"peakDiskUsagePercent\": \"\",\n \"averageDiskUsage\": \"\",\n \"averageDiskUsagePercent\": \"\"\n }\n },\n {\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"cpuUsage\": {\n \"peakCpuUsagePercent\": \"\",\n \"averageCpuUsagePercent\": \"\"\n },\n \"memoryUsage\": {\n \"totalMemoryUsageInMB\": \"\",\n \"peakMemoryUsageInMB\": \"\",\n \"peakMemoryUsagePercent\": \"\",\n \"averageMemoryUsageInMB\": \"\",\n \"averageMemoryUsagePercent\": \"\"\n },\n \"diskUsage\": {\n \"totalDiskSpaceUsageInMB\": \"\",\n \"peakDiskSpaceUsageInMB\": \"\",\n \"peakDiskUsagePercent\": \"\",\n \"averageDiskUsage\": \"\",\n \"averageDiskUsagePercent\": \"\"\n }\n }\n ],\n \"timeRange\": {\n \"from\": \"\",\n \"to\": \"\"\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": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "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": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "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": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "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": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present to indicate how many seconds you should wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "nodes", + ":nodeId", + "resourceUsage" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/nodes/:nodeId/resourceUsage?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security node.", + "key": "nodeId", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + } + ] + }, + { + "name": "Get availability details for Hybrid Data Security cluster", + "request": { + "description": "Get the availability details for an Hybrid Data Security cluster, where each segment specifies the start and end times, as well as the number of online, offline, and total nodes within that segment.\nTo obtain the Cluster ID needed for this API, use the [Get organization details API]()", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given period 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": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_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": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "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": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "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 method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or could not be processed. An accompanying error message will provide more details.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "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 with a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "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": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "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, please contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: The file(s) cannot be scanned for malware and must be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "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": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request was understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"context\": {\n \"orgId\": \"\",\n \"clusterId\": \"\",\n \"clusterName\": \"\"\n },\n \"availabilitySegments\": [\n {\n \"segmentStartTime\": \"\",\n \"segmentEndTime\": \"\",\n \"noOfOnlineNodes\": \"\",\n \"noOfOfflineNodes\": \"\",\n \"totalNodes\": \"\"\n },\n {\n \"segmentStartTime\": \"\",\n \"segmentEndTime\": \"\",\n \"noOfOnlineNodes\": \"\",\n \"noOfOfflineNodes\": \"\",\n \"totalNodes\": \"\"\n }\n ],\n \"timeRange\": {\n \"from\": \"\",\n \"to\": \"\"\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": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "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": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "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 to indicate how many seconds you should wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "hds", + "clusters", + ":clusterId", + "availability" + ], + "query": [ + { + "description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.", + "key": "from", + "value": "" + }, + { + "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.", + "key": "to", + "value": "" + } + ], + "raw": "{{baseUrl}}/hds/clusters/:clusterId/availability?from=&to=", + "variable": [ + { + "description": "Unique ID of the Hybrid Data Security cluster.", + "key": "clusterId", + "value": "" + } + ] + } + }, + "status": "Not Found" + } + ] + } + ], + "name": "Hybrid Data Security" } ], "variable": [ diff --git a/skill/admin/SKILL.md b/skill/admin/SKILL.md index 8f9e156..f82e2f3 100644 --- a/skill/admin/SKILL.md +++ b/skill/admin/SKILL.md @@ -312,6 +312,8 @@ webex admin service-apps get --service-app-id | `get` | `--org-id` *(required)* | | `generate-otp` | `--org-id` *(required)*, `--user-id` *(required)* | | `update` | `--org-id` *(required)*, `--schemas`, `--display-name`, `--preferred-language`, `--body`, `--body-file` | +| `update-authentication-configuration-settings` | `--org-id` *(required)*, `--schemas`, `--remember-my-login-id`, `--remember-my-login-id-duration`, `--mfa-enabled`, `--body`, `--body-file` | +| `update-password-policy` | `--org-id` *(required)*, `--schemas`, `--minimum-numeric`, `--minimum-cap-alpha`, `--minimum-low-alpha`, `--minimum-special`, `--minimum-length`, `--history-count`, `--max-password-age`, `--not-acceptable-strings`, `--body`, `--body-file` | ### events @@ -441,13 +443,15 @@ webex admin service-apps get --service-app-id | `list` | `--max`, `--from`, `--to`, `--meeting-id`, `--host-email`, `--site-url`, `--integration-tag`, `--topic`, `--format`, `--service-type`, `--status`, `--last` | | `list-admin-compliance-officer` | `--max`, `--from`, `--to`, `--meeting-id`, `--site-url`, `--integration-tag`, `--topic`, `--format`, `--service-type`, `--status`, `--last` | | `get` | `--recording-id` *(required)*, `--host-email` | -| `list-group` | `--person-id`, `--max`, `--from`, `--to`, `--site-url`, `--integration-tag`, `--topic`, `--format`, `--service-type`, `--last` | +| `list-group` | `--person-id`, `--max`, `--from`, `--to`, `--site-url`, `--integration-tag`, `--format`, `--service-type`, `--last` | | `get-group` | `--recording-id` *(required)*, `--person-id` | | `move-recycle-bin` | `--host-email`, `--recording-ids`, `--site-url`, `--body`, `--body-file` | | `restore-recycle-bin` | `--host-email`, `--restore-all`, `--recording-ids`, `--site-url`, `--body`, `--body-file` | | `purge-recycle-bin` | `--host-email`, `--purge-all`, `--recording-ids`, `--site-url`, `--body`, `--body-file` | | `share` | `--recording-id` *(required)*, `--host-email`, `--add-emails`, `--remove-emails`, `--send-email`, `--body`, `--body-file` | | `share-link` | `--host-email`, `--web-share-link`, `--add-emails`, `--remove-emails`, `--send-email`, `--body`, `--body-file` | +| `query` | `--max`, `--from`, `--to`, `--meeting-id`, `--site-url`, `--integration-tag`, `--host-email`, `--topic`, `--format`, `--service-type`, `--status`, `--body`, `--body-file` | +| `query-admin-compliance-officer` | `--max`, `--from`, `--to`, `--meeting-id`, `--site-url`, `--integration-tag`, `--topic`, `--format`, `--service-type`, `--status`, `--timezone`, `--body`, `--body-file` | | `delete-admin` | `--recording-id` *(required)* | | `delete` | `--recording-id` *(required)*, `--host-email`, `--reason`, `--comment`, `--body`, `--body-file` | @@ -463,7 +467,7 @@ webex admin service-apps get --service-app-id |---|---| | `list` | `--report-id`, `--service`, `--template-id`, `--from`, `--to`, `--last` | | `get` | `--report-id` *(required)* | -| `create` | `--template-id`, `--start-date`, `--end-date`, `--site-list`, `--body`, `--body-file` | +| `create` | `--template-id`, `--start-date`, `--end-date`, `--site-list`, `--time-zone`, `--body`, `--body-file` | | `delete` | `--report-id` *(required)* | ### resource-memberships @@ -599,5 +603,12 @@ webex admin service-apps get --service-app-id | Command | Flags | |---|---| | `get` | `--org-id` *(required)*, `--useruuid` *(required)* | +| `query` | `--org-id` *(required)*, `--filter` | + +### calling-metrics + +| Command | Flags | +|---|---| +| `webex-call-quality-stats` | `--from`, `--to`, `--location`, `--last` | diff --git a/skill/calling/SKILL.md b/skill/calling/SKILL.md index 40a92fb..a1b8f2c 100644 --- a/skill/calling/SKILL.md +++ b/skill/calling/SKILL.md @@ -270,6 +270,8 @@ webex calling call-settings-for-me upload-voicemail-no-answer-greeting --file gr | `list-history` | `--type` | | `list-member-id` | `--member-id` *(required)*, `--org-id` | | `get-member-id` | `--member-id` *(required)*, `--call-id` *(required)*, `--org-id` | +| `list-2` | `--line-owner-id` | +| `get-3` | `--call-id` *(required)*, `--line-owner-id` | | `dial` | `--destination`, `--endpoint-id`, `--single-number-reach-phone-number`, `--line-owner-id`, `--body`, `--body-file` | | `answer` | `--call-id`, `--endpoint-id`, `--line-owner-id`, `--body`, `--body-file` | | `reject` | `--call-id`, `--action`, `--line-owner-id`, `--body`, `--body-file` | @@ -294,6 +296,9 @@ webex calling call-settings-for-me upload-voicemail-no-answer-greeting --file gr | `answer-member-id` | `--member-id` *(required)*, `--org-id`, `--call-id`, `--endpoint-id`, `--body`, `--body-file` | | `hangup-member-id` | `--member-id` *(required)*, `--org-id`, `--call-id`, `--body`, `--body-file` | | `pull` | `--endpoint-id`, `--line-owner-id`, `--body`, `--body-file` | +| `dial-2` | `--destination`, `--endpoint-id`, `--single-number-reach-phone-number`, `--line-owner-id`, `--body`, `--body-file` | +| `answer-2` | `--call-id`, `--endpoint-id`, `--line-owner-id`, `--body`, `--body-file` | +| `hangup-2` | `--call-id`, `--line-owner-id`, `--body`, `--body-file` | ### call-routing diff --git a/skill/cc/SKILL.md b/skill/cc/SKILL.md index 3651864..a3d564d 100644 --- a/skill/cc/SKILL.md +++ b/skill/cc/SKILL.md @@ -373,25 +373,25 @@ webex cc address-book delete-entry-id --id |---|---| | `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--desktop-profile-filter`, `--provisioning-view`, `--single-object-response` | | `bulk-export` | `--orgid` *(required)*, `--type`, `--page`, `--page-size` | -| `list-skill-csqs-skill-profile` | `--orgid` *(required)*, `--id` *(required)* | +| `list-skill-based-skill-profile-id` | `--orgid` *(required)*, `--id` *(required)* | | `get-id` | `--orgid` *(required)*, `--id` *(required)*, `--agents-updated-info` | -| `list-csq-references-id` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `list-agent-based` | `--orgid` *(required)*, `--userid` *(required)*, `--search`, `--page`, `--page-size` | -| `list-skill-based` | `--orgid` *(required)*, `--userid` *(required)*, `--search`, `--page`, `--page-size` | -| `list-team-based` | `--orgid` *(required)*, `--userid` *(required)*, `--search`, `--page`, `--page-size` | +| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `list-agent-based-user-id` | `--orgid` *(required)*, `--userid` *(required)*, `--search`, `--page`, `--page-size` | +| `list-skill-based-user-id` | `--orgid` *(required)*, `--userid` *(required)*, `--search`, `--page`, `--page-size` | +| `list-team-based-user-id` | `--orgid` *(required)*, `--userid` *(required)*, `--search`, `--page`, `--page-size` | | `list-internal-skill-csqs-profile` | `--orgid` *(required)*, `--id` *(required)* | | `list-team-csqs-team-id` | `--orgid` *(required)*, `--id` *(required)* | | `list-agent-csqs-ci-user-id` | `--orgid` *(required)*, `--ci-user-id` *(required)* | | `list-skill-csqs-ci-user-id` | `--orgid` *(required)*, `--id` *(required)* | | `create` | `--orgid` *(required)*, `--body`, `--body-file` | | `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `delete-csq-references` | `--orgid` *(required)*, `--body`, `--body-file` | -| `list-manually-assignable-csqs` | `--orgid` *(required)*, `--agent-id`, `--team-id`, `--body`, `--body-file` | +| `delete-references` | `--orgid` *(required)*, `--body`, `--body-file` | +| `list-manually-assignable` | `--orgid` *(required)*, `--agent-id`, `--team-id`, `--body`, `--body-file` | | `purge-inactive` | `--orgid` *(required)*, `--next-start-id` | | `create-remove-agents-users-agent` | `--orgid` *(required)*, `--id` *(required)*, `--add`, `--remove`, `--body`, `--body-file` | | `list-mapping-summary-grouped-assistant-skill` | `--orgid` *(required)*, `--page`, `--page-size`, `--assistant-skill-ids`, `--body`, `--body-file` | -| `list-csqs-skills-profile` | `--orgid` *(required)*, `--body`, `--body-file` | -| `list-csqs-user-profile` | `--orgid` *(required)*, `--body`, `--body-file` | +| `list-skill-based-dynamic-skills-skill-profile` | `--orgid` *(required)*, `--body`, `--body-file` | +| `list-skill-based-skill-profile-id-user-id` | `--orgid` *(required)*, `--body`, `--body-file` | | `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | | `bulk-partial-update` | `--orgid` *(required)*, `--body`, `--body-file` | | `delete-id` | `--orgid` *(required)*, `--id` *(required)* | @@ -414,14 +414,14 @@ webex cc address-book delete-entry-id --id | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response` | +| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response`, `--provisioning-view` | | `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | | `get-id` | `--orgid` *(required)*, `--id` *(required)* | | `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--body`, `--body-file` | +| `create` | `--orgid` *(required)*, `--access-buddy-team`, `--access-entry-point`, `--access-idle-code`, `--access-queue`, `--access-wrap-up-code`, `--active`, `--agent-dnvalidation`, `--name`, `--parent-type`, `--viewable-statistics`, `--organization-id`, `--id`, `--version`, `--description`, `--site-id`, `--screen-popup`, `--last-agent-routing`, `--schedule-and-manage-call-back`, `--auto-wrap-up`, `--auto-answer`, `--agent-personal-greeting`, `--auto-wrap-after-seconds`, `--agent-available-after-outdial`, `--allow-auto-wrap-up-extension`, `--wrap-up-codes`, `--idle-codes`, `--queues`, `--entry-points`, `--buddy-teams`, `--consult-to-queue`, `--outdial-enabled`, `--outdial-entry-point-id`, `--outdial-aniid`, `--address-book-id`, `--dial-plan-enabled`, `--dial-plans`, `--agent-dnvalidation-criteria`, `--agent-dnvalidation-criterions`, `--login-voice-options`, `--threshold-rules`, `--timeout-desktop-inactivity-custom-enabled`, `--show-user-details-ms`, `--state-synchronization-ms`, `--show-user-details-webex`, `--state-synchronization-webex`, `--manage-channel-availability`, `--timeout-desktop-inactivity-mins`, `--system-default`, `--created-time`, `--last-updated-time`, `--auto-accept-digital-interactions`, `--body`, `--body-file` | | `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | | `purge-inactive` | `--orgid` *(required)*, `--next-start-id` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | +| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--access-buddy-team`, `--access-entry-point`, `--access-idle-code`, `--access-queue`, `--access-wrap-up-code`, `--active`, `--agent-dnvalidation`, `--name`, `--parent-type`, `--viewable-statistics`, `--organization-id`, `--version`, `--description`, `--site-id`, `--screen-popup`, `--last-agent-routing`, `--schedule-and-manage-call-back`, `--auto-wrap-up`, `--auto-answer`, `--agent-personal-greeting`, `--auto-wrap-after-seconds`, `--agent-available-after-outdial`, `--allow-auto-wrap-up-extension`, `--wrap-up-codes`, `--idle-codes`, `--queues`, `--entry-points`, `--buddy-teams`, `--consult-to-queue`, `--outdial-enabled`, `--outdial-entry-point-id`, `--outdial-aniid`, `--address-book-id`, `--dial-plan-enabled`, `--dial-plans`, `--agent-dnvalidation-criteria`, `--agent-dnvalidation-criterions`, `--login-voice-options`, `--threshold-rules`, `--timeout-desktop-inactivity-custom-enabled`, `--show-user-details-ms`, `--state-synchronization-ms`, `--show-user-details-webex`, `--state-synchronization-webex`, `--manage-channel-availability`, `--timeout-desktop-inactivity-mins`, `--system-default`, `--created-time`, `--last-updated-time`, `--auto-accept-digital-interactions`, `--body`, `--body-file` | | `delete-id` | `--orgid` *(required)*, `--id` *(required)* | ### dial-number @@ -447,9 +447,9 @@ webex cc address-book delete-entry-id --id | `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | | `get-id` | `--orgid` *(required)*, `--id` *(required)* | | `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--active`, `--name`, `--regular-expression`, `--organization-id`, `--id`, `--version`, `--description`, `--prefix`, `--stripped-chars`, `--system-default`, `--body`, `--body-file` | +| `create` | `--orgid` *(required)*, `--active`, `--name`, `--regular-expression`, `--organization-id`, `--id`, `--version`, `--description`, `--prefix`, `--stripped-chars`, `--system-default`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | | `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--active`, `--name`, `--regular-expression`, `--organization-id`, `--version`, `--description`, `--prefix`, `--stripped-chars`, `--system-default`, `--body`, `--body-file` | +| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--active`, `--name`, `--regular-expression`, `--organization-id`, `--version`, `--description`, `--prefix`, `--stripped-chars`, `--system-default`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | | `delete-id` | `--orgid` *(required)*, `--id` *(required)* | ### entry-point @@ -501,15 +501,15 @@ webex cc address-book delete-entry-id --id |---|---| | `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response` | | `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `list-entry` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | +| `list-entries` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | | `get-id` | `--orgid` *(required)*, `--id` *(required)* | | `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | | `get-entry-id` | `--orgid` *(required)*, `--out-dial-ani-id` *(required)*, `--id` *(required)* | -| `list-entry-2` | `--orgid` *(required)*, `--out-dial-ani-id` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | +| `list-entries-2` | `--orgid` *(required)*, `--out-dial-ani-id` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | | `create` | `--orgid` *(required)*, `--body`, `--body-file` | | `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | | `create-entry` | `--orgid` *(required)*, `--out-dial-ani-id` *(required)*, `--name`, `--number`, `--organization-id`, `--id`, `--version`, `--default-anientry`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `bulk-save-entry` | `--orgid` *(required)*, `--out-dial-ani-id` *(required)*, `--body`, `--body-file` | +| `bulk-save-entries` | `--orgid` *(required)*, `--out-dial-ani-id` *(required)*, `--body`, `--body-file` | | `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | | `update-entry-id` | `--orgid` *(required)*, `--out-dial-ani-id` *(required)*, `--id` *(required)*, `--name`, `--number`, `--organization-id`, `--version`, `--default-anientry`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | | `delete-id` | `--orgid` *(required)*, `--id` *(required)* | @@ -533,15 +533,15 @@ webex cc address-book delete-entry-id --id | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response` | +| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response`, `--include` | | `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | | `get-id` | `--orgid` *(required)*, `--id` *(required)* | | `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--active`, `--name`, `--service-level-threshold`, `--skill-type`, `--organization-id`, `--id`, `--version`, `--description`, `--enum-skill-values`, `--dynamic-skill`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `create` | `--orgid` *(required)*, `--body`, `--body-file` | | `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | | `purge-inactive` | `--orgid` *(required)*, `--next-start-id` | | `populate-json-attributes-field-skill-id-org` | `--orgid` *(required)*, `--id` *(required)* | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--active`, `--name`, `--service-level-threshold`, `--skill-type`, `--organization-id`, `--version`, `--description`, `--enum-skill-values`, `--dynamic-skill`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | | `delete-id` | `--orgid` *(required)*, `--id` *(required)* | ### skill-profile @@ -592,18 +592,19 @@ webex cc address-book delete-entry-id --id |---|---| | `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--supervisor-managed-agents-only`, `--single-object-response`, `--buddy-team-agents-only`, `--user-in-queue`, `--queue-id`, `--include-aimapping-count`, `--include-dynamic-skills-limit-reached` | | `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-ci-id` | `--orgid` *(required)*, `--id` *(required)*, `--include-user-profile`, `--include-names` | +| `get-ci-id` | `--orgid` *(required)*, `--id` *(required)*, `--include-user-profile`, `--include-names`, `--include-skill-details` | | `list-along-profile` | `--orgid` *(required)* | | `get-along-profile-id` | `--orgid` *(required)*, `--id` *(required)* | -| `get-id` | `--orgid` *(required)*, `--id` *(required)*, `--include-count`, `--include-user-profile-type`, `--include-skill-profile-audit`, `--include-reskill-audit-info`, `--include-skill-details` | +| `get-id` | `--orgid` *(required)*, `--id` *(required)*, `--include-count`, `--include-user-profile-type`, `--include-skill-profile-audit`, `--include-reskill-audit-info`, `--include-skill-details`, `--check-if-user-has-dynamic-skill`, `--dynamic-skill-id` | | `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | | `get-dynamic-skill-id` | `--orgid` *(required)*, `--skill-id` *(required)*, `--search`, `--page`, `--page-size` | -| `get-agents-matching-skill-requirements` | `--orgid` *(required)*, `--search`, `--page`, `--page-size`, `--condition`, `--skill-id`, `--skill-value`, `--organization-id`, `--id`, `--version`, `--skill-name`, `--skill-type`, `--weight`, `--dynamic-skill`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `get-ids` | `--orgid` *(required)*, `--page`, `--page-size`, `--user-ids`, `--search`, `--queue-id`, `--body`, `--body-file` | +| `list-call-monitoring-id` | `--orgid` *(required)*, `--id` *(required)*, `--page`, `--page-size` | +| `get-agents-matching-skill-requirements` | `--orgid` *(required)*, `--search`, `--page`, `--page-size`, `--body`, `--body-file` | +| `list-2` | `--orgid` *(required)*, `--page`, `--page-size`, `--user-ids`, `--search`, `--queue-id`, `--body`, `--body-file` | | `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | | `bulk-partial-update` | `--orgid` *(required)*, `--body`, `--body-file` | | `patch-id` | `--orgid` *(required)*, `--id` *(required)*, `--value-type`, `--body`, `--body-file` | -| `bulk-update-dynamic-skills` | `--orgid` *(required)*, `--skill-id` *(required)*, `--body`, `--body-file` | +| `bulk-partial-update-dynamic-skills` | `--orgid` *(required)*, `--skill-id` *(required)*, `--body`, `--body-file` | | `reskill-agents` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | ### work-types @@ -695,6 +696,7 @@ webex cc address-book delete-entry-id --id | `end-request` | `--task-id` *(required)* | | `hold-request` | `--task-id` *(required)* | | `unhold-request` | `--task-id` *(required)* | +| `whisper-coach-request` | `--interaction-id` *(required)* | | `delete-request` | `--request-id` *(required)* | ### tasks @@ -707,7 +709,7 @@ webex cc address-book delete-entry-id --id | `end` | `--task-id` *(required)* | | `wrap-up` | `--task-id` *(required)*, `--wrap-up-reason`, `--aux-code-id`, `--body`, `--body-file` | | `hold` | `--task-id` *(required)*, `--media-resource-id`, `--body`, `--body-file` | -| `resume` | `--task-id` *(required)*, `--media-resource-id`, `--body`, `--body-file` | +| `unhold` | `--task-id` *(required)*, `--media-resource-id`, `--body`, `--body-file` | | `reject` | `--task-id` *(required)*, `--media-resource-id`, `--body`, `--body-file` | | `pause-recording` | `--task-id` *(required)* | | `resume-recording` | `--task-id` *(required)*, `--auto-resumed`, `--body`, `--body-file` | @@ -722,7 +724,10 @@ webex cc address-book delete-entry-id --id | `accept-preview` | `--campaign-id` *(required)*, `--task-id` *(required)* | | `skip-preview` | `--campaign-id` *(required)*, `--task-id` *(required)* | | `delete-preview` | `--campaign-id` *(required)*, `--task-id` *(required)* | -| `update-2` | `--task-id` *(required)*, `--body`, `--body-file` | +| `append-message` | `--task-id` *(required)*, `--body`, `--body-file` | +| `drop-participant-conference` | `--task-id` *(required)*, `--participant-id` *(required)* | +| `pause` | `--task-id` *(required)* | +| `resume` | `--task-id` *(required)* | | `update` | `--task-id` *(required)*, `--body`, `--body-file` | ### journey @@ -773,8 +778,9 @@ webex cc address-book delete-entry-id --id | Command | Flags | |---|---| +| `get-valid-times` | `--org-id` *(required)*, `--campaign-id`, `--interaction-id`, `--agent-id`, `--tracking-id` | | `start-request` | `--body`, `--body-file` | -| `update-request` | `--campaign-id` *(required)*, `--dialing-rate`, `--dialing-list-fetch-url`, `--outdial-ani`, `--campaign-name`, `--auth-token`, `--no-answer-ring-limit`, `--max-dialing-rate`, `--reservation-percentage`, `--preview-offer-timeout`, `--preview-offer-timeout-auto-action`, `--preview-actions-disabled`, `--body`, `--body-file` | +| `update-request` | `--campaign-id` *(required)*, `--body`, `--body-file` | | `stop-request` | `--campaign-id` *(required)* | ### captures @@ -819,13 +825,13 @@ webex cc address-book delete-entry-id --id | Command | Flags | |---|---| -| `get-id-v2-api` | `--orgid` *(required)*, `--id` *(required)*, `--include-url` | +| `get-id` | `--orgid` *(required)*, `--id` *(required)*, `--include-url` | | `list` | `--orgid` *(required)*, `--filter`, `--search`, `--attributes`, `--page`, `--page-size`, `--include-agent-details` | -| `create-v2-api` | `--orgid` *(required)*, `--body`, `--body-file` | -| `delete-references-1` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-id-v2-api` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `patch-id-v2-api` | `--orgid` *(required)*, `--id` *(required)*, `--attribute-tag`, `--greeting-purpose-id`, `--body`, `--body-file` | -| `delete-id-v2-api` | `--orgid` *(required)*, `--id` *(required)* | +| `create` | `--orgid` *(required)*, `--body`, `--body-file` | +| `delete-references` | `--orgid` *(required)*, `--body`, `--body-file` | +| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | +| `patch-id` | `--orgid` *(required)*, `--id` *(required)*, `--attribute-tag`, `--greeting-purpose-id`, `--body`, `--body-file` | +| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | ### journey-customer-identification @@ -926,13 +932,14 @@ webex cc address-book delete-entry-id --id | `create-within` | `--campaign-id` *(required)*, `--contact-list-id` *(required)*, `--body`, `--body-file` | | `update-status-within` | `--campaign-id` *(required)*, `--contact-list-id` *(required)*, `--contact-id` *(required)*, `--contact-status`, `--body`, `--body-file` | | `update-status` | `--campaign-id` *(required)*, `--contact-list-id` *(required)*, `--contact-list-status`, `--body`, `--body-file` | +| `update-status-across-campaign-chain` | `--campaign-id` *(required)*, `--contact-id` *(required)*, `--contact-list-id`, `--fields`, `--contact-status`, `--search-across-the-campaign-chain`, `--body`, `--body-file` | ### agent-summaries | Command | Flags | |---|---| | `list` | `--org-id`, `--interaction-id`, `--search-type`, `--body`, `--body-file` | -| `list-2` | `--org-id`, `--agent-ci-user-id`, `--search-type`, `--body`, `--body-file` | +| `list-2` | `--org-id`, `--search-type`, `--body`, `--body-file` | ### ai-assistant @@ -940,4 +947,139 @@ webex cc address-book delete-entry-id --id |---|---| | `get-suggestions` | `--body`, `--body-file` | +### activities + +| Command | Flags | +|---|---| +| `list-definitions` | `--org-id` *(required)*, `--project-id` *(required)* | +| `describe` | `--org-id` *(required)*, `--project-id` *(required)*, `--activity-name` *(required)* | +| `get-input-choices` | `--org-id` *(required)*, `--project-id` *(required)*, `--activity-name` *(required)*, `--input-name` *(required)*, `--mode`, `--query`, `--value`, `--parent_inputs` | +| `list-definitions-2` | `--org-id` *(required)*, `--project-id` *(required)* | +| `describe-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--activity-name` *(required)* | +| `get-input-choices-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--activity-name` *(required)*, `--input-name` *(required)*, `--search`, `--validate`, `--parent-value`, `--parent-input-name` | + +### events + +| Command | Flags | +|---|---| +| `list-specifications` | `--org-id` *(required)*, `--project-id` *(required)* | +| `list-specifications-2` | `--org-id` *(required)*, `--project-id` *(required)* | + +### flows + +| Command | Flags | +|---|---| +| `list` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-type`, `--ids`, `--page`, `--partial-name-search`, `--search-by`, `--size`, `--include-pagination`, `--is-validation` | +| `get` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--flow-type` | +| `validate-draft` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--version-id`, `--flow-type` | +| `export` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--version`, `--flow-type` | +| `list-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-type`, `--ids`, `--page`, `--partial-name-search`, `--search-by`, `--size`, `--include-pagination`, `--is-validation` | +| `get-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--flow-type` | +| `validate-draft-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--version-id`, `--flow-type` | +| `export-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--version`, `--flow-type` | +| `search` | `--org-id` *(required)*, `--project-id` *(required)*, `--query`, `--flow-type`, `--page`, `--size`, `--key-value-filter` | +| `publish` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--skip-validation`, `--flow-type`, `--comment`, `--tag-ids`, `--body`, `--body-file` | +| `lock` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--flow-type` | +| `unlock` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--flow-type` | +| `validate` | `--org-id` *(required)*, `--project-id` *(required)*, `--body`, `--body-file` | +| `import` | `--org-id` *(required)*, `--project-id` *(required)*, `--overwrite`, `--flow-type`, `--body`, `--body-file` | +| `save-draft` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--expected-version`, `--flow-type`, `--body`, `--body-file` | +| `publish-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--skip-validation`, `--flow-type`, `--comment`, `--tag-ids`, `--body`, `--body-file` | +| `lock-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--flow-type` | +| `unlock-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--flow-type` | +| `validate-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--body`, `--body-file` | +| `import-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--overwrite`, `--flow-type`, `--body`, `--body-file` | +| `save-draft-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--expected-version`, `--flow-type`, `--body`, `--body-file` | +| `patch-draft` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--expected-version`, `--flow-type`, `--body`, `--body-file` | +| `patch-draft-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--expected-version`, `--flow-type`, `--body`, `--body-file` | +| `delete` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--force`, `--skip-rs-epcheck`, `--flow-type` | + +### functions + +| Command | Flags | +|---|---| +| `list-custom` | `--org-id` *(required)*, `--is-partial-match`, `--is-case-sensitive`, `--name`, `--language`, `--status`, `--sort-by`, `--page`, `--size`, `--ids`, `--fields`, `--is-validation` | +| `get-custom` | `--org-id` *(required)*, `--id` *(required)*, `--version-or-tag`, `--meta-data-only` | +| `list-options` | `--org-id` *(required)*, `--language`, `--runtime` | +| `create-custom` | `--org-id` *(required)*, `--body`, `--body-file` | +| `import-custom` | `--org-id` *(required)*, `--overwrite`, `--associated-rcs` | +| `unlock-custom` | `--org-id` *(required)*, `--id` *(required)* | +| `lock-custom` | `--org-id` *(required)*, `--id` *(required)* | +| `test-custom` | `--org-id` *(required)*, `--id` *(required)*, `--body`, `--body-file` | +| `publish-custom` | `--org-id` *(required)*, `--id` *(required)*, `--tags`, `--comment`, `--key_0`, `--key_1`, `--key_2`, `--key_3`, `--body`, `--body-file` | +| `export-custom` | `--org-id` *(required)*, `--id` *(required)*, `--version-or-tag` | +| `update-custom` | `--org-id` *(required)*, `--id` *(required)*, `--body`, `--body-file` | +| `delete-custom` | `--org-id` *(required)*, `--id` *(required)*, `--is-force-deletion` | + +### legacy-flows + +| Command | Flags | +|---|---| +| `export` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--version`, `--flow-type` | +| `import` | `--org-id` *(required)*, `--project-id` *(required)*, `--overwrite`, `--flow-type` | + +### templates + +| Command | Flags | +|---|---| +| `list-flow` | `--org-id` *(required)*, `--project-id` *(required)*, `--type` | +| `get-flow` | `--org-id` *(required)*, `--project-id` *(required)*, `--id` *(required)* | +| `list-flow-2` | `--type` | +| `get-flow-2` | `--id` *(required)* | + +### campaign-group + +| Command | Flags | +|---|---| +| `list` | `--campaign-group-name` *(required)*, `--page`, `--page-size`, `--campaign-status` | + +### search-metadata + +| Command | Flags | +|---|---| +| `get` | — | + +### asset + +| Command | Flags | +|---|---| +| `get-id` | `--orgid` *(required)*, `--id` *(required)*, `--include-channel-name` | +| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-count`, `--single-object-response`, `--include-channel-name`, `--exclude-epassociated` | +| `create` | `--orgid` *(required)*, `--body`, `--body-file` | +| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | +| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | +| `patch-id` | `--orgid` *(required)*, `--id` *(required)*, `--value-type`, `--body`, `--body-file` | +| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | + +### channel + +| Command | Flags | +|---|---| +| `get-id` | `--orgid` *(required)*, `--id` *(required)*, `--include-logo-url-versioned` | +| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-count`, `--single-object-response`, `--include-logo-url-versioned` | +| `create` | `--orgid` *(required)*, `--body`, `--body-file` | +| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | +| `update-id` | `--orgid` *(required)*, `--id` *(required)* | +| `patch-id` | `--orgid` *(required)*, `--id` *(required)*, `--description`, `--logo-type`, `--logo-icon-name`, `--body`, `--body-file` | +| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | + +### usage-reports + +| Command | Flags | +|---|---| +| `get-available-types` | — | +| `list` | `--resource-type`, `--created-after`, `--created-before` | +| `get` | `--report-id` *(required)* | +| `download-file` | `--file-id` *(required)* | +| `create` | `--resource-type`, `--start-date`, `--end-date`, `--body`, `--body-file` | +| `delete` | `--report-id` *(required)* | + +### external-data-updates + +| Command | Flags | +|---|---| +| `update-task-global-variables` | `--body`, `--body-file` | + diff --git a/skill/meetings/SKILL.md b/skill/meetings/SKILL.md index 2ebe1d1..672c989 100644 --- a/skill/meetings/SKILL.md +++ b/skill/meetings/SKILL.md @@ -369,6 +369,7 @@ webex meetings meeting-polls list --meeting-id | `list-survey-results` | `--meeting-id` *(required)*, `--meeting-start-time-from`, `--meeting-start-time-to`, `--max` | | `list-invitation-sources` | `--meeting-id` *(required)* | | `list-tracking-codes` | `--site-url`, `--service`, `--host-email` | +| `list-group` | `--person-id`, `--meeting-number`, `--web-link`, `--current` | | `create` | `--body`, `--body-file` | | `join` | `--meeting-id`, `--meeting-number`, `--web-link`, `--join-directly`, `--email`, `--display-name`, `--password`, `--expiration-minutes`, `--registration-id`, `--host-email`, `--create-join-link-as-web-link`, `--create-start-link-as-web-link`, `--body`, `--body-file` | | `register-registrant` | `--meeting-id` *(required)*, `--current`, `--host-email`, `--body`, `--body-file` | @@ -384,6 +385,7 @@ webex meetings meeting-polls list --meeting-id | `batch-reject-registrants` | `--meeting-id` *(required)*, `--current`, `--host-email`, `--body`, `--body-file` | | `batch-cancel-registrants` | `--meeting-id` *(required)*, `--current`, `--host-email`, `--body`, `--body-file` | | `batch-delete-registrants` | `--meeting-id` *(required)*, `--current`, `--host-email`, `--body`, `--body-file` | +| `update-group-control-status` | `--person-id`, `--meeting-id`, `--action`, `--body`, `--body-file` | | `update` | `--meeting-id` *(required)*, `--body`, `--body-file` | | `update-control-status` | `--meeting-id`, `--recording-started`, `--recording-paused`, `--locked`, `--body`, `--body-file` | | `update-registration-form` | `--meeting-id` *(required)*, `--body`, `--body-file` | @@ -391,6 +393,7 @@ webex meetings meeting-polls list --meeting-id | `update-interpreter` | `--meeting-id` *(required)*, `--interpreter-id` *(required)*, `--language-code1`, `--language-code2`, `--email`, `--display-name`, `--host-email`, `--send-email`, `--body`, `--body-file` | | `update-breakout-sessions` | `--meeting-id` *(required)*, `--body`, `--body-file` | | `patch` | `--meeting-id` *(required)*, `--body`, `--body-file` | +| `patch-group` | `--meeting-id` *(required)*, `--person-id`, `--body`, `--body-file` | | `delete` | `--meeting-id` *(required)*, `--host-email`, `--send-email` | | `delete-registration-form` | `--meeting-id` *(required)* | | `delete-registrant` | `--meeting-id` *(required)*, `--registrant-id` *(required)*, `--current`, `--host-email` | @@ -436,13 +439,15 @@ webex meetings meeting-polls list --meeting-id | `list` | `--max`, `--from`, `--to`, `--meeting-id`, `--host-email`, `--site-url`, `--integration-tag`, `--topic`, `--format`, `--service-type`, `--status`, `--last` | | `list-admin-compliance-officer` | `--max`, `--from`, `--to`, `--meeting-id`, `--site-url`, `--integration-tag`, `--topic`, `--format`, `--service-type`, `--status`, `--last` | | `get` | `--recording-id` *(required)*, `--host-email` | -| `list-group` | `--person-id`, `--max`, `--from`, `--to`, `--site-url`, `--integration-tag`, `--topic`, `--format`, `--service-type`, `--last` | +| `list-group` | `--person-id`, `--max`, `--from`, `--to`, `--site-url`, `--integration-tag`, `--format`, `--service-type`, `--last` | | `get-group` | `--recording-id` *(required)*, `--person-id` | | `move-recycle-bin` | `--host-email`, `--recording-ids`, `--site-url`, `--body`, `--body-file` | | `restore-recycle-bin` | `--host-email`, `--restore-all`, `--recording-ids`, `--site-url`, `--body`, `--body-file` | | `purge-recycle-bin` | `--host-email`, `--purge-all`, `--recording-ids`, `--site-url`, `--body`, `--body-file` | | `share` | `--recording-id` *(required)*, `--host-email`, `--add-emails`, `--remove-emails`, `--send-email`, `--body`, `--body-file` | | `share-link` | `--host-email`, `--web-share-link`, `--add-emails`, `--remove-emails`, `--send-email`, `--body`, `--body-file` | +| `query` | `--max`, `--from`, `--to`, `--meeting-id`, `--site-url`, `--integration-tag`, `--host-email`, `--topic`, `--format`, `--service-type`, `--status`, `--body`, `--body-file` | +| `query-admin-compliance-officer` | `--max`, `--from`, `--to`, `--meeting-id`, `--site-url`, `--integration-tag`, `--topic`, `--format`, `--service-type`, `--status`, `--timezone`, `--body`, `--body-file` | | `delete-admin` | `--recording-id` *(required)* | | `delete` | `--recording-id` *(required)*, `--host-email`, `--reason`, `--comment`, `--body`, `--body-file` | diff --git a/skill/messaging/SKILL.md b/skill/messaging/SKILL.md index b1fa52f..27f4073 100644 --- a/skill/messaging/SKILL.md +++ b/skill/messaging/SKILL.md @@ -359,5 +359,25 @@ webex messaging events list --resource messages --type created | `get-availability-cluster` | `--cluster-id` *(required)*, `--from`, `--to`, `--last` | | `get-database-org-2` | `--organization-id` *(required)* | | `get-multi-tenant-org-2` | `--organization-id` *(required)* | +| `list-nodes-cluster` | `--cluster-id` *(required)* | +| `list-clusters-org` | `--organization-id` *(required)* | +| `get-alarms-node` | `--node-id` *(required)*, `--from`, `--to`, `--last` | +| `get-usage-node` | `--node-id` *(required)*, `--from`, `--to`, `--last` | + +### hybrid-data-security + +| Command | Flags | +|---|---| +| `get-org` | `--organization-id` *(required)* | +| `list-clusters-org` | `--organization-id` *(required)* | +| `get-cluster` | `--cluster-id` *(required)* | +| `list-nodes-cluster` | `--cluster-id` *(required)* | +| `get-node` | `--node-id` *(required)* | +| `get-database-org` | `--organization-id` *(required)* | +| `get-multi-tenant-org` | `--organization-id` *(required)* | +| `get-alarms-node` | `--node-id` *(required)*, `--from`, `--to`, `--last` | +| `get-test-results-node` | `--node-id` *(required)*, `--trigger-type` | +| `get-usage-node` | `--node-id` *(required)*, `--from`, `--to`, `--last` | +| `get-availability-cluster` | `--cluster-id` *(required)*, `--from`, `--to`, `--last` | From 5abe01b79829ce00aaa6c5554dd85b565ce942d7 Mon Sep 17 00:00:00 2001 From: Ed Umansky Date: Fri, 9 Oct 2026 13:22:16 -0600 Subject: [PATCH 2/6] Normalize refreshed API commands and update documentation inventories --- AGENTS.md | 10 + CLAUDE_DESKTOP.md | 6 + README.md | 18 +- cmd/calling/call_controls.go | 172 --- cmd/calling/call_controls_for_me.go | 200 ++++ .../calling_metrics.go => calling/metrics.go} | 16 +- cmd/cc/activities.go | 117 +-- cmd/cc/agent_personal_greeting_files.go | 42 +- cmd/cc/contact_service_queue.go | 60 +- cmd/cc/events.go | 29 - cmd/cc/flow.go | 506 ++++++++- cmd/cc/flows.go | 985 ------------------ cmd/cc/functions.go | 44 +- cmd/cc/legacy_flows.go | 98 -- cmd/cc/outdial_ani.go | 23 +- cmd/cc/tasks.go | 22 +- cmd/cc/templates.go | 67 +- cmd/cc/usage_reports.go | 4 +- cmd/cc/users.go | 16 +- cmd/messaging/hds.go | 19 +- cmd/messaging/hybrid_data_security.go | 398 ------- codegen/INVENTORY.md | 198 ++++ codegen/NAMING.md | 215 ++++ codegen/extract_api_spec.py | 59 ++ codegen/generate_cli.py | 7 + codegen/generate_skills.py | 14 +- codegen/naming_overrides.py | 292 ++++++ codegen/test_naming_overrides.py | 108 ++ site/README.md | 52 +- site/src/content/docs/admin.mdx | 6 + site/src/content/docs/agent-skill.mdx | 6 + site/src/content/docs/calling.mdx | 16 + site/src/content/docs/cc.mdx | 59 +- site/src/content/docs/device.mdx | 1 + site/src/content/docs/index.mdx | 6 +- site/src/content/docs/meetings.mdx | 7 + site/src/content/docs/messaging.mdx | 13 + skill/SKILL.md | 28 +- skill/admin/SKILL.md | 107 +- skill/calling/SKILL.md | 40 +- skill/cc/SKILL.md | 751 ++++++------- skill/device/SKILL.md | 1 + skill/meetings/SKILL.md | 7 + skill/messaging/SKILL.md | 36 +- 44 files changed, 2357 insertions(+), 2524 deletions(-) create mode 100644 cmd/calling/call_controls_for_me.go rename cmd/{admin/calling_metrics.go => calling/metrics.go} (92%) delete mode 100644 cmd/cc/flows.go delete mode 100644 cmd/cc/legacy_flows.go delete mode 100644 cmd/messaging/hybrid_data_security.go create mode 100644 codegen/INVENTORY.md create mode 100644 codegen/NAMING.md create mode 100644 codegen/naming_overrides.py create mode 100644 codegen/test_naming_overrides.py diff --git a/AGENTS.md b/AGENTS.md index 9f4e300..711cfe5 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -31,6 +31,12 @@ make download `make codegen` runs `extract_api_spec.py`, `generate_cli.py`, and `generate_skills.py`. +For command naming exceptions, edit `codegen/naming_overrides.py`; see +`codegen/NAMING.md` for naming and compatibility conventions, and +`codegen/INVENTORY.md` for the reviewed refresh inventory. These route-based +overrides feed both generated commands and skill references. Use `custom_*.go` +and the generator skip lists when the request itself needs handwritten handling. + No API key is required — collections are fetched from the Webex Public Workspace via Postman's public gateway (`codegen/download_collections.py`). A weekly GitHub Actions workflow (`.github/workflows/update-collections.yml`) downloads collections, regenerates commands and skills, and opens or updates a PR. It also has `workflow_dispatch`. If GitHub has disabled it for inactivity, re-enable it under Actions after merging workflow fixes. @@ -76,3 +82,7 @@ gh release edit v0.X.0 --title "v0.X.0" --notes "## Improvements - `codegen/generate_cli.py` — API spec → Go cobra command files - `codegen/generate_skills.py` — API spec → Command Reference blocks in `skill//SKILL.md` - `codegen/diff_spec.py` — Changelog between two spec snapshots (used by the weekly workflow) + +## Documentation checks + +Update README, the site area pages, and handwritten skill guidance alongside API changes. Run `make codegen` for all six generated skill references, `python3 -m unittest discover -s codegen -p 'test_*.py'` for naming checks, and `npm run build` in `site/` for documentation validation. Preserve the live-test evidence and known import limitations in the naming reference. diff --git a/CLAUDE_DESKTOP.md b/CLAUDE_DESKTOP.md index ef52d9b..ae59d02 100644 --- a/CLAUDE_DESKTOP.md +++ b/CLAUDE_DESKTOP.md @@ -144,3 +144,9 @@ Run `webex login` in a terminal, then retry. Tokens are stored in the OS keyring **Wrong Webex org** Use `webex auth set-org ` to set a persistent org override, or pass `--organization ` on individual commands via the `flags` parameter. + +## Updated command references + +Use the repository skill files from the same revision as your CLI. The Postman refresh adds Calling metrics/personal controls, Contact Center flow authoring and functions, usage reports, and HDS monitoring. See the [refresh inventory](codegen/INVENTORY.md) and [command migration map](codegen/NAMING.md). + +`cc flow import`/`export` now use current-format flow JSON; `export-legacy` retains raw FDL. Legacy flow import and custom-function import still lack their upload implementations. `cc tasks resume` remains a voice-unhold alias; digital tasks use `resume-digital`. Refresh previously installed skill copies after upgrading the CLI. diff --git a/README.md b/README.md index 0941976..375cf1e 100644 --- a/README.md +++ b/README.md @@ -91,11 +91,11 @@ All upload commands support `--dry-run` to preview the request without sending i ### Calling (`webex calling`) -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. +49 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 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. +64 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`) @@ -113,6 +113,16 @@ All upload commands support `--dry-run` to preview the request without sending i 12 resource groups including rooms, messages, memberships, teams, team memberships, webhooks, events, attachment actions, room tabs, and more. +## Postman refresh: command changes + +- Calling adds `call-controls-for-me` and `metrics get-call-quality-stats`. +- Contact Center adds flow activity/event/template discovery, custom functions, assets/channels, usage reports, campaign groups, search metadata, and completed-task variable updates. +- `cc flow import`/`export` now use the current FlowV2 format. Use `export-legacy` for raw FDL; `import-legacy` upload handling remains incomplete. `functions import` also needs multipart upload handling. +- `cc tasks resume` still means voice unhold. Digital tasks use `pause-digital`/`resume-digital`. +- Messaging consolidates HDS operations under `hds`, with `hybrid-data-security` as an alias. Admin and Meetings add body-based recording searches; Meetings also adds group service-app operations. + +See the [full refresh inventory](codegen/INVENTORY.md), [every renamed command](codegen/NAMING.md), and [Contact Center skill](skill/cc/SKILL.md) for migration details and examples. Upstream collections remain unchanged; overrides control names, routes, and product placement. + ## Authentication - **OAuth PKCE flow** — `webex login` opens a browser, no client secret needed on the user side @@ -225,13 +235,13 @@ And 2 MCP resources: | `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. +Rather than exposing fixed per-API tools, the dispatcher pattern lets AI clients invoke the full CLI surface via `webex_read` and `webex_write` — 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: +All dispatcher 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 diff --git a/cmd/calling/call_controls.go b/cmd/calling/call_controls.go index 5e215a1..6172368 100644 --- a/cmd/calling/call_controls.go +++ b/cmd/calling/call_controls.go @@ -1088,176 +1088,4 @@ func init() { callControlsCmd.AddCommand(cmd) } - { // dial-2 - var destination string - var endpointId string - var singleNumberReachPhoneNumber string - var lineOwnerId string - var bodyRaw string - var bodyFile string - cmd := &cobra.Command{ - Use: "dial-2", - Short: "Dial", - Long: `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.`, - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/calls/members/me/dial") - if bodyFile != "" { - if err := req.SetBodyFile(bodyFile); err != nil { - return err - } - } else if bodyRaw != "" { - req.SetBodyRaw(bodyRaw) - } else { - req.BodyString("destination", destination) - req.BodyString("endpointId", endpointId) - req.BodyString("singleNumberReachPhoneNumber", singleNumberReachPhoneNumber) - req.BodyString("lineOwnerId", lineOwnerId) - } - resp, statusCode, err := req.Do() - if err != nil { - return err - } - return output.Print(resp, statusCode) - }, - } - 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") - callControlsCmd.AddCommand(cmd) - } - - { // answer-2 - var callId string - var endpointId string - var lineOwnerId string - var bodyRaw string - var bodyFile string - cmd := &cobra.Command{ - Use: "answer-2", - Short: "Answer", - Long: `Answer an incoming call. When no endpointId is specified, the call is answered on the user's primary device. When an endpointId is specified, the call is answered on the device or application identified by the endpointId. The answer API is rejected if the device is not alerting for the call or the device does not support answer via API.`, - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/calls/members/me/answer") - if bodyFile != "" { - if err := req.SetBodyFile(bodyFile); err != nil { - return err - } - } else if bodyRaw != "" { - req.SetBodyRaw(bodyRaw) - } else { - req.BodyString("callId", callId) - req.BodyString("endpointId", endpointId) - req.BodyString("lineOwnerId", lineOwnerId) - } - resp, statusCode, err := req.Do() - if err != nil { - return err - } - return output.Print(resp, statusCode) - }, - } - cmd.Flags().StringVar(&callId, "call-id", "", "") - cmd.Flags().StringVar(&endpointId, "endpoint-id", "", "") - 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") - callControlsCmd.AddCommand(cmd) - } - - { // hangup-2 - var callId string - var lineOwnerId string - var bodyRaw string - var bodyFile string - cmd := &cobra.Command{ - Use: "hangup-2", - Short: "Hangup", - Long: `Hangup a call. If used on an unanswered incoming call, the call is rejected and sent to busy.`, - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/calls/members/me/hangup") - if bodyFile != "" { - if err := req.SetBodyFile(bodyFile); err != nil { - return err - } - } else if bodyRaw != "" { - req.SetBodyRaw(bodyRaw) - } else { - req.BodyString("callId", callId) - req.BodyString("lineOwnerId", lineOwnerId) - } - resp, statusCode, err := req.Do() - if err != nil { - return err - } - return output.Print(resp, statusCode) - }, - } - cmd.Flags().StringVar(&callId, "call-id", "", "") - 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") - callControlsCmd.AddCommand(cmd) - } - - { // list-2 - var lineOwnerId string - cmd := &cobra.Command{ - Use: "list-2", - Short: "List Calls", - Long: `Get the list of details for all active calls associated with the user.`, - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/calls/members/me/calls") - req.QueryParam("lineOwnerId", lineOwnerId) - 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(&lineOwnerId, "line-owner-id", "", "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.") - callControlsCmd.AddCommand(cmd) - } - - { // get-3 - var callId string - var lineOwnerId string - cmd := &cobra.Command{ - Use: "get-3", - Short: "Get Call Details", - Long: `Get the details of the specified active call for the user.`, - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/calls/members/me/calls/{callId}") - req.PathParam("callId", callId) - req.QueryParam("lineOwnerId", lineOwnerId) - 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(&callId, "call-id", "", "The call identifier of the call.") - cmd.MarkFlagRequired("call-id") - cmd.Flags().StringVar(&lineOwnerId, "line-owner-id", "", "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.") - callControlsCmd.AddCommand(cmd) - } - } diff --git a/cmd/calling/call_controls_for_me.go b/cmd/calling/call_controls_for_me.go new file mode 100644 index 0000000..67d486d --- /dev/null +++ b/cmd/calling/call_controls_for_me.go @@ -0,0 +1,200 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package calling + +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 callControlsForMeCmd = &cobra.Command{ + Use: "call-controls-for-me", + Short: "CallControlsForMe commands", +} + +func init() { + cmd.CallingCmd.AddCommand(callControlsForMeCmd) + + { // dial + var destination string + var endpointId string + var singleNumberReachPhoneNumber string + var lineOwnerId string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "dial", + Short: "Dial", + Long: `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.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/calls/members/me/dial") + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("destination", destination) + req.BodyString("endpointId", endpointId) + req.BodyString("singleNumberReachPhoneNumber", singleNumberReachPhoneNumber) + req.BodyString("lineOwnerId", lineOwnerId) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + 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") + callControlsForMeCmd.AddCommand(cmd) + } + + { // answer + var callId string + var endpointId string + var lineOwnerId string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "answer", + Short: "Answer", + Long: `Answer an incoming call. When no endpointId is specified, the call is answered on the user's primary device. When an endpointId is specified, the call is answered on the device or application identified by the endpointId. The answer API is rejected if the device is not alerting for the call or the device does not support answer via API.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/calls/members/me/answer") + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("callId", callId) + req.BodyString("endpointId", endpointId) + req.BodyString("lineOwnerId", lineOwnerId) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&callId, "call-id", "", "") + cmd.Flags().StringVar(&endpointId, "endpoint-id", "", "") + 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") + callControlsForMeCmd.AddCommand(cmd) + } + + { // hangup + var callId string + var lineOwnerId string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "hangup", + Short: "Hangup", + Long: `Hangup a call. If used on an unanswered incoming call, the call is rejected and sent to busy.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/calls/members/me/hangup") + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("callId", callId) + req.BodyString("lineOwnerId", lineOwnerId) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&callId, "call-id", "", "") + 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") + callControlsForMeCmd.AddCommand(cmd) + } + + { // list + var lineOwnerId string + cmd := &cobra.Command{ + Use: "list", + Short: "List Calls", + Long: `Get the list of details for all active calls associated with the user.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/calls/members/me/calls") + req.QueryParam("lineOwnerId", lineOwnerId) + 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(&lineOwnerId, "line-owner-id", "", "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.") + callControlsForMeCmd.AddCommand(cmd) + } + + { // get + var callId string + var lineOwnerId string + cmd := &cobra.Command{ + Use: "get", + Short: "Get Call Details", + Long: `Get the details of the specified active call for the user.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/calls/members/me/calls/{callId}") + req.PathParam("callId", callId) + req.QueryParam("lineOwnerId", lineOwnerId) + 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(&callId, "call-id", "", "The call identifier of the call.") + cmd.MarkFlagRequired("call-id") + cmd.Flags().StringVar(&lineOwnerId, "line-owner-id", "", "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API.") + callControlsForMeCmd.AddCommand(cmd) + } + +} diff --git a/cmd/admin/calling_metrics.go b/cmd/calling/metrics.go similarity index 92% rename from cmd/admin/calling_metrics.go rename to cmd/calling/metrics.go index bf3adf9..bd5dad1 100644 --- a/cmd/admin/calling_metrics.go +++ b/cmd/calling/metrics.go @@ -1,6 +1,6 @@ // Code generated by codegen/generate_cli.py; DO NOT EDIT. -package admin +package calling import ( "fmt" @@ -19,21 +19,21 @@ var _ = config.Token var _ = output.Print var _ = timeutil.ParseLastISO -var callingMetricsCmd = &cobra.Command{ - Use: "calling-metrics", - Short: "CallingMetrics commands", +var metricsCmd = &cobra.Command{ + Use: "metrics", + Short: "Metrics commands", } func init() { - cmd.AdminCmd.AddCommand(callingMetricsCmd) + cmd.CallingCmd.AddCommand(metricsCmd) - { // webex-call-quality-stats + { // get-call-quality-stats var from string var to string var location string var last string cmd := &cobra.Command{ - Use: "webex-call-quality-stats", + Use: "get-call-quality-stats", Short: "Webex Calling Call Quality Stats", Long: `Returns aggregated Webex Calling call and media-quality statistics for the authenticated organization. A call or media session is classified as good quality when all available audio and video quality measurements meet their defined thresholds. Missing individual quality measurements do not cause the call or session to be classified as poor quality. @@ -72,7 +72,7 @@ This operation requires a Pro Pack for Control Hub license. The access token mus cmd.Flags().StringVar(&to, "to", "", "Exclusive UTC end time in yyyy-MM-ddTHH:mm:ssZ format. A value later than the current time is clamped to the current time. If omitted while from is provided, it is the earlier of seven days after from and the current time. If both times are omitted, it is the current time.") cmd.Flags().StringVar(&location, "location", "", "Exact Webex Calling location name. Omit it or provide an empty value to include all locations.") cmd.Flags().StringVar(&last, "last", "", "Time range shorthand (e.g. 1h, 30m, 24h). Sets --from automatically.") - callingMetricsCmd.AddCommand(cmd) + metricsCmd.AddCommand(cmd) } } diff --git a/cmd/cc/activities.go b/cmd/cc/activities.go index 7bea220..008690b 100644 --- a/cmd/cc/activities.go +++ b/cmd/cc/activities.go @@ -32,7 +32,7 @@ func init() { Short: "List Activity Definitions", Long: "List all available activity types with their full schemas, including inputs, outputs, ports, and descriptions. The response is sufficient on its own to construct nodes \u2014 there is no separate schema endpoint.\n\nScope: `cjp:config_read`", RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/activities") + req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/activities") req.PathParam("orgid", orgid) req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") if config.Paginate() { @@ -61,117 +61,6 @@ func init() { Use: "describe", Short: "Describe an Activity", Long: "Retrieve a single activity's full definition, including inputs, outputs, named ports, and the JSON Schema for its inputs \u2014 all returned inline.\n\nScope: `cjp:config_read`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/activities/{activityName}") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("activityName", activityName) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&activityName, "activity-name", "", "Activity type name (e.g., `play-message`, `queue-contact`).") - cmd.MarkFlagRequired("activity-name") - activitiesCmd.AddCommand(cmd) - } - - { // get-input-choices - var orgid string - var activityName string - var inputName string - var mode string - var query string - var value string - var parent_inputs string - cmd := &cobra.Command{ - Use: "get-input-choices", - Short: "Get Activity Input Choices", - Long: "Resolve choices for an activity input. Use this when an activity input requires a value from a predefined or dynamically resolved set (e.g., available queues, audio files, agents).\n\nThis endpoint is only valid for inputs that expose choices (an input whose definition includes `allowedValues` or a `choicesEndpoint`, as returned by `describeActivity`). Calling it for an input that does not support choices returns 400.\n\n**Modes:**\n- `list` \u2014 Returns the full set of allowed values for a static-choice input.\n- `search` \u2014 Returns matches for the supplied `query` string. Use for type-ahead UIs over large choice sets.\n- `validate` \u2014 Checks whether a single `value` is allowed and returns its label/metadata if so.\n- `dynamic` \u2014 Resolves cascading choices whose allowed values depend on one or more sibling inputs. Pass the relevant sibling values via `parent_inputs` (e.g., a queue list scoped to a previously selected team).\n\nScope: `cjp:config_read`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/activities/{activityName}/inputs/{inputName}/choices") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("activityName", activityName) - req.PathParam("inputName", inputName) - req.QueryParam("mode", mode) - req.QueryParam("query", query) - req.QueryParam("value", value) - req.QueryParam("parent_inputs", parent_inputs) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&activityName, "activity-name", "", "Activity type name.") - cmd.MarkFlagRequired("activity-name") - cmd.Flags().StringVar(&inputName, "input-name", "", "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).") - cmd.MarkFlagRequired("input-name") - cmd.Flags().StringVar(&mode, "mode", "", "Resolution mode. Defaults to `list`.") - cmd.Flags().StringVar(&query, "query", "", "Search term. Required when `mode=search`.") - cmd.Flags().StringVar(&value, "value", "", "Candidate value to validate. Required when `mode=validate`.") - cmd.Flags().StringVar(&parent_inputs, "parent_inputs", "", "JSON object of parent input values used for cascading resolution. Required when `mode=dynamic`.") - activitiesCmd.AddCommand(cmd) - } - - { // list-definitions-2 - var orgid string - cmd := &cobra.Command{ - Use: "list-definitions-2", - Short: "List Activity Definitions", - Long: "List all available activity types with their full schemas, including inputs, outputs, ports, and descriptions. The response is sufficient on its own to construct nodes \u2014 there is no separate schema endpoint.\n\nScope: `cjp:config_read`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/activities") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - 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.") - cmd.MarkFlagRequired("orgid") - activitiesCmd.AddCommand(cmd) - } - - { // describe-2 - var orgid string - var activityName string - cmd := &cobra.Command{ - Use: "describe-2", - Short: "Describe an Activity", - Long: "Retrieve a single activity's full definition, including inputs, outputs, named ports, and the JSON Schema for its inputs \u2014 all returned inline.\n\nScope: `cjp:config_read`", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/activities/{activityName}") req.PathParam("orgid", orgid) @@ -198,7 +87,7 @@ func init() { activitiesCmd.AddCommand(cmd) } - { // get-input-choices-2 + { // get-input-choices var orgid string var activityName string var inputName string @@ -207,7 +96,7 @@ func init() { var parentValue string var parentInputName string cmd := &cobra.Command{ - Use: "get-input-choices-2", + Use: "get-input-choices", Short: "Get Activity Input Choices", Long: "Resolve choices for an activity input. Use this when an activity input requires a value from a predefined or dynamically resolved set (e.g., available queues, audio files, agents).\n\nThis endpoint is only valid for inputs that expose choices (an input whose definition includes `allowedValues` or a `choicesEndpoint`, as returned by `describeActivity`). Calling it for an input that does not support choices returns 400.\n\nPass `search` to filter the choices (type-ahead). Add `validate=true` together with `search` to do a point-lookup of a single value instead of filtering \u2014 the match is against the choice's `value` (its ID), not its display `name`. For a cascading input whose allowed values depend on a sibling input, supply the parent with `parentInputName` and `parentValue`; otherwise a cascading input returns 400.\n\nFiltering and validation apply only to dynamic (`choicesEndpoint`-backed) inputs. A static input always returns its full enumerated list regardless of `search`/`validate`.\n\nScope: `cjp:config_read`", RunE: func(cmd *cobra.Command, args []string) error { diff --git a/cmd/cc/agent_personal_greeting_files.go b/cmd/cc/agent_personal_greeting_files.go index 259fbad..a8746f6 100644 --- a/cmd/cc/agent_personal_greeting_files.go +++ b/cmd/cc/agent_personal_greeting_files.go @@ -30,9 +30,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "create", - Short: "Create a new Greeting File", - Long: `Create a new Greeting File in a given organization.`, + Use: "create", + Aliases: []string{"create-v2-api"}, + Short: "Create a new Greeting File", + Long: `Create a new Greeting File in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/v2/agent-personal-greeting") req.PathParam("orgid", orgid) @@ -62,9 +63,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "delete-references", - Short: "Delete references of an agent from greeting files", - Long: `Removes all references of the specified agent (ciUserId) from greeting files in the given organization. Typically invoked when an agent is deleted or unassigned. in a given organization.`, + Use: "delete-references", + Aliases: []string{"delete-references-1"}, + Short: "Delete references of an agent from greeting files", + Long: `Removes all references of the specified agent (ciUserId) from greeting files in the given organization. Typically invoked when an agent is deleted or unassigned. in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/agent-personal-greeting/delete-reference") req.PathParam("orgid", orgid) @@ -94,9 +96,10 @@ func init() { var id string var includeUrl string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Greeting File by ID", - Long: `Retrieve an existing Greeting File by ID in a given organization.`, + Use: "get-id", + Aliases: []string{"get-id-v2-api"}, + Short: "Get specific Greeting File by ID", + Long: `Retrieve an existing Greeting File by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/agent-personal-greeting/{id}") req.PathParam("orgid", orgid) @@ -130,9 +133,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Greeting File by ID", - Long: `Update an existing Greeting File by ID in a given organization.`, + Use: "update-id", + Aliases: []string{"update-id-v2-api"}, + Short: "Update specific Greeting File by ID", + Long: `Update an existing Greeting File by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/v2/agent-personal-greeting/{id}") req.PathParam("orgid", orgid) @@ -164,9 +168,10 @@ func init() { var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Greeting File by ID", - Long: `Delete an existing Greeting File by ID in a given organization.`, + Use: "delete-id", + Aliases: []string{"delete-id-v2-api"}, + Short: "Delete specific Greeting File by ID", + Long: `Delete an existing Greeting File by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/v2/agent-personal-greeting/{id}") req.PathParam("orgid", orgid) @@ -193,9 +198,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "patch-id", - Short: "Partially update Greeting File by ID", - Long: `Partially update Greeting File by ID in a given organization.`, + Use: "patch-id", + Aliases: []string{"patch-id-v2-api"}, + Short: "Partially update Greeting File by ID", + Long: `Partially update Greeting File by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PATCH", "/organization/{orgid}/v2/agent-personal-greeting/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/contact_service_queue.go b/cmd/cc/contact_service_queue.go index 4f72445..12313c8 100644 --- a/cmd/cc/contact_service_queue.go +++ b/cmd/cc/contact_service_queue.go @@ -215,13 +215,14 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // list-skill-based-skill-profile-id + { // list-by-skill-profile var orgid string var id string cmd := &cobra.Command{ - Use: "list-skill-based-skill-profile-id", - Short: "List skill-based Contact Service Queues by skill profile ID (public)", - Long: `Retrieve a list of skill-based Contact Service Queues associated with a given skill profile ID, accessible to authorized clients in a given organization.`, + Use: "list-by-skill-profile", + Aliases: []string{"list-skill-csqs-skill-profile"}, + Short: "List skill-based Contact Service Queues by skill profile ID (public)", + Long: `Retrieve a list of skill-based Contact Service Queues associated with a given skill profile ID, accessible to authorized clients 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) @@ -252,9 +253,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "delete-references", - Short: "Delete references from Contact Service Queues", - Long: `Removes the references to the specified entities (such as teams, sites, or agents) from Contact Service Queues for a given organization.`, + Use: "delete-references", + Aliases: []string{"delete-csq-references"}, + Short: "Delete references from Contact Service Queues", + Long: `Removes the references to the specified entities (such as teams, sites, or agents) from Contact Service Queues for 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) @@ -286,9 +288,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "list-manually-assignable", - Short: "List manually assignable Contact Service Queues", - Long: `Retrieve a list of Contact Service Queues that are eligible for manual contact assignment based on the provided criteria in a given organization.`, + Use: "list-manually-assignable", + Aliases: []string{"list-manually-assignable-csqs"}, + Short: "List manually assignable Contact Service Queues", + Long: `Retrieve a list of Contact Service Queues that are eligible for manual contact assignment based on the provided criteria 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) @@ -445,9 +448,10 @@ func init() { var page string var pageSize string cmd := &cobra.Command{ - Use: "list-references", - Short: "List references for a specific Contact Service Queue", - Long: `Retrieve a list of all entities that have reference to an existing Contact Service Queue by ID in a given organization.`, + Use: "list-references", + Aliases: []string{"list-csq-references-id"}, + Short: "List references for a specific Contact Service Queue", + 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") req.PathParam("orgid", orgid) @@ -479,14 +483,14 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // list-agent-based-user-id + { // list-agent-based var orgid string var userid string var search string var page string var pageSize string cmd := &cobra.Command{ - Use: "list-agent-based-user-id", + Use: "list-agent-based", Short: "List agent-based Contact Service Queues by user ID", Long: `Retrieve a list of agent-based Contact Service Queues by user ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { @@ -520,14 +524,14 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // list-skill-based-user-id + { // list-skill-based var orgid string var userid string var search string var page string var pageSize string cmd := &cobra.Command{ - Use: "list-skill-based-user-id", + Use: "list-skill-based", Short: "List skill-based Contact Service Queues by user ID", Long: `Retrieve a list of skill-based Contact Service Queues by user ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { @@ -561,14 +565,14 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // list-team-based-user-id + { // list-team-based var orgid string var userid string var search string var page string var pageSize string cmd := &cobra.Command{ - Use: "list-team-based-user-id", + Use: "list-team-based", Short: "List team-based Contact Service Queues by user ID", Long: `Retrieve a list of team-based Contact Service Queues by user ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { @@ -783,14 +787,15 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // list-skill-based-dynamic-skills-skill-profile + { // list-by-dynamic-skills var orgid string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "list-skill-based-dynamic-skills-skill-profile", - Short: "List skill-based Contact Service Queues by dynamic skills and skill profile", - Long: `Retrieve a list of skill-based Contact Service Queues that match the given dynamic skills and skill profile criteria in a given organization.`, + Use: "list-by-dynamic-skills", + Aliases: []string{"list-csqs-skills-profile"}, + Short: "List skill-based Contact Service Queues by dynamic skills and skill profile", + Long: `Retrieve a list of skill-based Contact Service Queues that match the given dynamic skills and skill profile criteria 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) @@ -815,14 +820,15 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // list-skill-based-skill-profile-id-user-id + { // list-by-user-skill-profile var orgid string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "list-skill-based-skill-profile-id-user-id", - Short: "List skill-based Contact Service Queues by skill profile ID and user ID", - Long: `Retrieve a list of skill-based Contact Service Queues associated with the given skill profile ID and user ID combination in a given organization.`, + Use: "list-by-user-skill-profile", + Aliases: []string{"list-csqs-user-profile"}, + Short: "List skill-based Contact Service Queues by skill profile ID and user ID", + Long: `Retrieve a list of skill-based Contact Service Queues associated with the given skill profile ID and user ID combination 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) diff --git a/cmd/cc/events.go b/cmd/cc/events.go index e24182d..3742624 100644 --- a/cmd/cc/events.go +++ b/cmd/cc/events.go @@ -31,35 +31,6 @@ func init() { Use: "list-specifications", Short: "List Event Specifications", Long: "List the event types available for use in `event_flows[]`. Each entry describes the event name, payload schema, and any contextual metadata bound when the event fires.\n\nScope: `cjp:config_read`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/event-specifications") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - 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.") - cmd.MarkFlagRequired("orgid") - eventsCmd.AddCommand(cmd) - } - - { // list-specifications-2 - var orgid string - cmd := &cobra.Command{ - Use: "list-specifications-2", - Short: "List Event Specifications", - Long: "List the event types available for use in `event_flows[]`. Each entry describes the event name, payload schema, and any contextual metadata bound when the event fires.\n\nScope: `cjp:config_read`", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/event-specifications") req.PathParam("orgid", orgid) diff --git a/cmd/cc/flow.go b/cmd/cc/flow.go index 6c94b87..865b87a 100644 --- a/cmd/cc/flow.go +++ b/cmd/cc/flow.go @@ -4,6 +4,7 @@ package cc import ( "fmt" + "strconv" "strings" cmd "github.com/Cloverhound/webex-cli/cmd" @@ -17,30 +18,101 @@ import ( var _ = fmt.Sprintf var _ = config.Token var _ = output.Print +var _ = strconv.Itoa var _ = strings.Join var flowCmd = &cobra.Command{ - Use: "flow", - Short: "Flow commands", + Use: "flow", + Aliases: []string{"flows"}, + Short: "Flow commands", } func init() { cmd.CcCmd.AddCommand(flowCmd) + { // export-legacy + var orgid string + var flowId string + var version string + cmd := &cobra.Command{ + Use: "export-legacy", + Short: "Export a Flow or Subflow", + Long: "Returns the exported flow/subflow in response.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/flows/{flowId}:export") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("version", version) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&version, "version", "", "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.") + flowCmd.AddCommand(cmd) + } + + { // import-legacy + var orgid string + var overwrite string + var flowType string + var contentLength string + cmd := &cobra.Command{ + Use: "import-legacy", + Short: "Import a Flow or Subflow", + Long: "Returns the imported flow/subflow in response.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/flows:import") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.QueryParam("overwrite", overwrite) + req.QueryParam("flowType", flowType) + req.Header("Content-Length", contentLength) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&overwrite, "overwrite", "", "Determines whether to overwrite the existing flow or not. Possible values: yes/no.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + cmd.Flags().StringVar(&contentLength, "content-length", "", "Content length value in number of bytes.") + flowCmd.AddCommand(cmd) + } + { // list var orgid string var flowType string var ids string var page string var partialNameSearch string + var searchBy string var size string var includePagination string + var isValidation string cmd := &cobra.Command{ Use: "list", Short: "List Flows or Subflows", - Long: "Returns a list of flows in response.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", + Long: "Returns a list of flows in response. Channel-based filtering can be applied with the `searchBy` query parameter (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`). Channel visibility may be constrained by organization feature flags. If associatedChannels key is missing or empty, it will be treated as telephony flow.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/flows") + req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/flows") req.PathParam("orgid", orgid) req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") req.QueryParam("flowType", flowType) @@ -48,8 +120,10 @@ func init() { req.QueryParam("ids", ids) req.QueryParam("page", page) req.QueryParam("partialNameSearch", partialNameSearch) + req.QueryParam("searchBy", searchBy) req.QueryParam("size", size) req.QueryParam("includePagination", includePagination) + req.QueryParam("isValidation", isValidation) if config.Paginate() { resp, statusCode, err := req.DoPaginated(false) if err != nil { @@ -70,31 +144,44 @@ func init() { cmd.Flags().StringVar(&ids, "ids", "", "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.") cmd.Flags().StringVar(&page, "page", "", "Defines the number of the displayed page. The page number starts from 0.") cmd.Flags().StringVar(&partialNameSearch, "partial-name-search", "", "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.") + cmd.Flags().StringVar(&searchBy, "search-by", "", "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).") cmd.Flags().StringVar(&size, "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(&includePagination, "include-pagination", "", "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\".") + cmd.Flags().StringVar(&includePagination, "include-pagination", "", "If set 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\".") + cmd.Flags().StringVar(&isValidation, "is-validation", "", "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.") flowCmd.AddCommand(cmd) } - { // export + { // publish var orgid string var flowId string - var version string + var skipValidation string + var flowType string + var trackingId string + var comment string + var tagIds []string + var bodyRaw string + var bodyFile string cmd := &cobra.Command{ - Use: "export", - Short: "Export a Flow or Subflow", - Long: "Returns the exported flow/subflow in response.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", + Use: "publish", + Short: "Publish a Flow or Subflow", + Long: "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_write`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/flows/{flowId}:export") + req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/flows/{flowId}:publish") req.PathParam("orgid", orgid) req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") req.PathParam("flowId", flowId) - req.QueryParam("version", version) - if config.Paginate() { - resp, statusCode, err := req.DoPaginated(false) - if err != nil { + req.QueryParam("skipValidation", skipValidation) + req.QueryParam("flowType", flowType) + req.Header("TrackingId", trackingId) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { return err } - return output.Print(resp, statusCode) + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("comment", comment) + req.BodyStringSlice("tagIds", tagIds) } resp, statusCode, err := req.Do() if err != nil { @@ -107,37 +194,92 @@ func init() { cmd.MarkFlagRequired("orgid") cmd.Flags().StringVar(&flowId, "flow-id", "", "") cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&version, "version", "", "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.") + cmd.Flags().StringVar(&skipValidation, "skip-validation", "", "If true, the flow's pre-publish validation is skipped. Use with care.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + cmd.Flags().StringVar(&trackingId, "tracking-id", "", "ID for tracking.") + cmd.Flags().StringVar(&comment, "comment", "", "") + cmd.Flags().StringSliceVar(&tagIds, "tag-ids", nil, "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") flowCmd.AddCommand(cmd) } - { // publish + { // lock var orgid string var flowId string - var trackingId string - var comment string - var tagIds []string + var flowType string + cmd := &cobra.Command{ + Use: "lock", + Short: "Lock a Flow or Subflow", + Long: "Lock a flow to prevent concurrent edits by other users. Locks expire after 15 minutes of inactivity.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/flows/{flowId}:lock") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("flowType", flowType) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + flowCmd.AddCommand(cmd) + } + + { // unlock + var orgid string + var flowId string + var flowType string + cmd := &cobra.Command{ + Use: "unlock", + Short: "Unlock a Flow or Subflow", + Long: "Release the lock on a flow to allow other users to edit it.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/flows/{flowId}:unlock") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("flowType", flowType) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + flowCmd.AddCommand(cmd) + } + + { // validate + var orgid string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "publish", - Short: "Publish a Flow or Subflow", - Long: "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`]", + Use: "validate", + Short: "Validate a Flow or Subflow", + Long: "Dry-run validate a flow/subflow definition without persisting it. Use this to check correctness before importing. Include `associatedChannels` to preserve the channel metadata that import and export payloads round-trip. Validation requests where `associatedChannels` is missing or empty are treated as telephony flows, and dry-run validation does not derive the effective channel from `associatedChannels`.\n\nNote: validation is more lenient than import. A flow that passes `:validate` can still be rejected by `:import` (for example, a missing start activity), so a successful validation does not guarantee a successful import.\n\nScope: `cjp:config_write`", RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/flows/{flowId}:publish") + req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/v2/flows:validate") req.PathParam("orgid", orgid) req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.Header("TrackingId", trackingId) if bodyFile != "" { if err := req.SetBodyFile(bodyFile); err != nil { return err } } else if bodyRaw != "" { req.SetBodyRaw(bodyRaw) - } else { - req.BodyString("comment", comment) - req.BodyStringSlice("tagIds", tagIds) } resp, statusCode, err := req.Do() if err != nil { @@ -148,11 +290,6 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&trackingId, "tracking-id", "", "ID for tracking.") - cmd.Flags().StringVar(&comment, "comment", "", "") - cmd.Flags().StringSliceVar(&tagIds, "tag-ids", nil, "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") flowCmd.AddCommand(cmd) @@ -162,18 +299,25 @@ func init() { var orgid string var overwrite string var flowType string - var contentLength string + var bodyRaw string + var bodyFile string cmd := &cobra.Command{ Use: "import", Short: "Import a Flow or Subflow", - Long: "Returns the imported flow/subflow in response.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", + Long: "Import a new flow/subflow from a flow definition. Creates the flow/subflow in draft state and returns the assigned flow metadata, including `flowId`. Include `associatedChannels` in the payload when the flow contains channel-specific activities (for example, `customMessaging`) so channel references can be resolved correctly during import. If `associatedChannels` is missing or empty, the import is treated as a telephony flow. For `FLOW` imports, blank or whitespace-only `associatedChannels[].channelType` values are rejected.\n\nScope: `cjp:config_write`", RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/flows:import") + req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/v2/flows:import") req.PathParam("orgid", orgid) req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") req.QueryParam("overwrite", overwrite) req.QueryParam("flowType", flowType) - req.Header("Content-Length", contentLength) + 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 @@ -183,9 +327,289 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&overwrite, "overwrite", "", "Determines whether to overwrite the existing flow or not. Possible values: yes/no.") + cmd.Flags().StringVar(&overwrite, "overwrite", "", "If true, replaces an existing flow with the same name. Defaults to false.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + flowCmd.AddCommand(cmd) + } + + { // get + var orgid string + var flowId string + var flowType string + cmd := &cobra.Command{ + Use: "get", + Short: "Get a Flow or Subflow", + Long: "Retrieve the current draft of a flow/subflow as a flow document. To fetch a specific published version, use the `:export` endpoint. The response includes channel metadata (for example, `associatedChannels`) used by channel-specific activities such as `customMessaging`. If `associatedChannels` is missing or empty, the flow is treated as telephony.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/flows/{flowId}") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "Flow ID.") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + flowCmd.AddCommand(cmd) + } + + { // save-draft + var orgid string + var flowId string + var expectedVersion string + var flowType string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "save-draft", + Short: "Save a Flow or Subflow Draft", + Long: "Save a complete flow/subflow document as the current draft, replacing the existing draft. Submitted `associatedChannels` values are not persisted on save; the draft preserves the existing stored channel metadata. Omitting `associatedChannels` does not default an existing flow to telephony. Pass `expectedVersion` as a query parameter to enable optimistic locking; the request fails with `409 Conflict` if the server-side version does not match. Omit `expectedVersion` to skip the check.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/v2/flows/{flowId}") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("expectedVersion", expectedVersion) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "Flow ID.") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&expectedVersion, "expected-version", "", "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + flowCmd.AddCommand(cmd) + } + + { // patch-draft + var orgid string + var flowId string + var expectedVersion string + var flowType string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "patch-draft", + Short: "Patch a Flow or Subflow Draft", + Long: "Apply partial updates to an existing flow/subflow draft without replacing the entire document. The patch body is a Patch Draft Contract \u2014 server-side merge, idempotent, and re-validated after the merge. The patch is rejected if the merged document fails validation, so the draft is never left in a broken state. The body may also include top-level overrides such as `name` and `description`. Submitted `associatedChannels` values are not persisted on patch; the draft preserves the existing stored channel metadata.\n\nPass `expectedVersion` as a query parameter to enable optimistic locking; the request fails with `409 Conflict` if the server-side version does not match. Omit `expectedVersion` to skip the check.\n\nScope: `cjp:config_write`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "PATCH", "/{orgid}/project/{projectId}/v2/flows/{flowId}") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("expectedVersion", expectedVersion) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "Flow ID.") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&expectedVersion, "expected-version", "", "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + flowCmd.AddCommand(cmd) + } + + { // validate-draft + var orgid string + var flowId string + var versionId string + var flowType string + cmd := &cobra.Command{ + Use: "validate-draft", + Short: "Validate an Existing Flow or Subflow Draft", + Long: "Validate the current draft of an existing flow/subflow (read-only operation). Validation reads the draft as stored. Drafts where `associatedChannels` is missing or empty are treated as telephony flows, and validation does not derive the effective channel from `associatedChannels`.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/flows/{flowId}:validate") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("versionId", versionId) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&versionId, "version-id", "", "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + flowCmd.AddCommand(cmd) + } + + { // export + var orgid string + var flowId string + var version string + var flowType string + cmd := &cobra.Command{ + Use: "export", + Short: "Export a Flow or Subflow", + Long: "Export a flow/subflow as a flow document for backup, migration, or version control. The exported payload includes `associatedChannels` metadata to preserve channel-specific activity behavior (for example, `customMessaging`) during re-import. If `associatedChannels` is missing or empty, the flow is treated as telephony.\n\nScope: `cjp:config_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/flows/{flowId}:export") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("version", version) + req.QueryParam("flowType", flowType) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&version, "version", "", "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") + flowCmd.AddCommand(cmd) + } + + { // search + var orgid string + var query string + var flowType string + var page string + var size string + var keyValueFilter string + cmd := &cobra.Command{ + Use: "search", + Short: "Search Flows", + Long: "Returns a list of flows in response. The search is case-sensitive.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/flows:search") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.QueryParam("query", query) + req.QueryParam("flowType", flowType) + req.QueryParam("page", page) + req.QueryParam("size", size) + req.QueryParam("keyValueFilter", keyValueFilter) + 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.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&query, "query", "", "Searches for flows with the given query. The search is case-sensitive.") + cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW' or 'ALL'. Default value is 'ALL'.") + cmd.Flags().StringVar(&page, "page", "", "Defines the number of the displayed page. The page number starts from 0.") + cmd.Flags().StringVar(&size, "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(&keyValueFilter, "key-value-filter", "", "Filters results based on key-value pairs. Format: 'key1|value1,key2|value2'. This will add a filter on normalizedFlow collection directly instead of running query on atlas.") + flowCmd.AddCommand(cmd) + } + + { // delete + var orgid string + var flowId string + var force string + var skipRsEpcheck string + var flowType string + cmd := &cobra.Command{ + Use: "delete", + Short: "Delete a Flow or Subflow", + Long: "Permanently deletes a flow or subflow. Flows deleted via this API are removed permanently and cannot be recovered.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "DELETE", "/{orgid}/project/{projectId}/flows/{flowId}") + req.PathParam("orgid", orgid) + req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req.PathParam("flowId", flowId) + req.QueryParam("force", force) + req.QueryParam("skipRsEPCheck", skipRsEpcheck) + req.QueryParam("flowType", flowType) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&flowId, "flow-id", "", "ID of the flow/subflow to delete.") + cmd.MarkFlagRequired("flow-id") + cmd.Flags().StringVar(&force, "force", "", "If 'yes', the flow is deleted even if it is still referenced by other entities. Defaults to 'no'.") + cmd.Flags().StringVar(&skipRsEpcheck, "skip-rs-epcheck", "", "If true, skips the check for routing strategy and entry point associations before deleting the flow.") cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - cmd.Flags().StringVar(&contentLength, "content-length", "", "Content length value in number of bytes.") flowCmd.AddCommand(cmd) } diff --git a/cmd/cc/flows.go b/cmd/cc/flows.go deleted file mode 100644 index d935f92..0000000 --- a/cmd/cc/flows.go +++ /dev/null @@ -1,985 +0,0 @@ -// Code generated by codegen/generate_cli.py; DO NOT EDIT. - -package cc - -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 flowsCmd = &cobra.Command{ - Use: "flows", - Short: "Flows commands", -} - -func init() { - cmd.CcCmd.AddCommand(flowsCmd) - - { // list - var orgid string - var flowType string - var ids string - var page string - var partialNameSearch string - var searchBy string - var size string - var includePagination string - var isValidation string - cmd := &cobra.Command{ - Use: "list", - Short: "List Flows or Subflows", - Long: "Returns a list of flows in response. Channel-based filtering can be applied with the `searchBy` query parameter (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`). Channel visibility may be constrained by organization feature flags.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/flows") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.QueryParam("flowType", flowType) - req.QueryParam("ids", ids) - req.QueryParam("ids", ids) - req.QueryParam("page", page) - req.QueryParam("partialNameSearch", partialNameSearch) - req.QueryParam("searchBy", searchBy) - req.QueryParam("size", size) - req.QueryParam("includePagination", includePagination) - req.QueryParam("isValidation", isValidation) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - cmd.Flags().StringVar(&ids, "ids", "", "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.") - cmd.Flags().StringVar(&page, "page", "", "Defines the number of the displayed page. The page number starts from 0.") - cmd.Flags().StringVar(&partialNameSearch, "partial-name-search", "", "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.") - cmd.Flags().StringVar(&searchBy, "search-by", "", "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).") - cmd.Flags().StringVar(&size, "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(&includePagination, "include-pagination", "", "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\".") - cmd.Flags().StringVar(&isValidation, "is-validation", "", "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.") - flowsCmd.AddCommand(cmd) - } - - { // publish - var orgid string - var flowId string - var skipValidation string - var flowType string - var trackingId string - var comment string - var tagIds []string - var bodyRaw string - var bodyFile string - cmd := &cobra.Command{ - Use: "publish", - Short: "Publish a Flow or Subflow", - Long: "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`]", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/flows/{flowId}:publish") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("skipValidation", skipValidation) - req.QueryParam("flowType", flowType) - req.Header("TrackingId", trackingId) - if bodyFile != "" { - if err := req.SetBodyFile(bodyFile); err != nil { - return err - } - } else if bodyRaw != "" { - req.SetBodyRaw(bodyRaw) - } else { - req.BodyString("comment", comment) - req.BodyStringSlice("tagIds", tagIds) - } - resp, statusCode, err := req.Do() - if err != nil { - return err - } - return output.Print(resp, statusCode) - }, - } - cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&skipValidation, "skip-validation", "", "If true, the flow's pre-publish validation is skipped. Use with care.") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - cmd.Flags().StringVar(&trackingId, "tracking-id", "", "ID for tracking.") - cmd.Flags().StringVar(&comment, "comment", "", "") - cmd.Flags().StringSliceVar(&tagIds, "tag-ids", nil, "") - cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") - cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") - flowsCmd.AddCommand(cmd) - } - - { // lock - var orgid string - var flowId string - var flowType string - cmd := &cobra.Command{ - Use: "lock", - Short: "Lock a Flow or Subflow", - Long: "Lock a flow to prevent concurrent edits by other users. Locks expire after 15 minutes of inactivity.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/flows/{flowId}:lock") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("flowType", flowType) - resp, statusCode, err := req.Do() - if err != nil { - return err - } - return output.Print(resp, statusCode) - }, - } - cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - flowsCmd.AddCommand(cmd) - } - - { // unlock - var orgid string - var flowId string - var flowType string - cmd := &cobra.Command{ - Use: "unlock", - Short: "Unlock a Flow or Subflow", - Long: "Release the lock on a flow to allow other users to edit it.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/flows/{flowId}:unlock") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("flowType", flowType) - resp, statusCode, err := req.Do() - if err != nil { - return err - } - return output.Print(resp, statusCode) - }, - } - cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - flowsCmd.AddCommand(cmd) - } - - { // validate - var orgid string - var bodyRaw string - var bodyFile string - cmd := &cobra.Command{ - Use: "validate", - Short: "Validate a Flow", - Long: "Dry-run validate a flow definition without persisting it. Use this to check correctness before importing.\n\nNote: validation is more lenient than import. A flow that passes `:validate` can still be rejected by `:import` (for example, a missing start activity), so a successful validation does not guarantee a successful import.\n\nScope: `cjp:config_write`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/v2/flows:validate") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") - cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") - flowsCmd.AddCommand(cmd) - } - - { // import - var orgid string - var overwrite string - var flowType string - var bodyRaw string - var bodyFile string - cmd := &cobra.Command{ - Use: "import", - Short: "Import a Flow", - Long: "Import a new flow from a flow definition. Creates the flow in draft state and returns the assigned flow metadata, including `flowId`.\n\nScope: `cjp:config_write`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/v2/flows:import") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.QueryParam("overwrite", overwrite) - req.QueryParam("flowType", flowType) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&overwrite, "overwrite", "", "If true, replaces an existing flow with the same name. Defaults to false.") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") - cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") - flowsCmd.AddCommand(cmd) - } - - { // get - var orgid string - var flowId string - var flowType string - cmd := &cobra.Command{ - Use: "get", - Short: "Get a Flow", - Long: "Retrieve the current draft of a flow as a flow document. To fetch a specific published version, use the `:export` endpoint.\n\nScope: `cjp:config_read`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/flows/{flowId}") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("flowType", flowType) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "Flow ID.") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - flowsCmd.AddCommand(cmd) - } - - { // save-draft - var orgid string - var flowId string - var expectedVersion string - var flowType string - var bodyRaw string - var bodyFile string - cmd := &cobra.Command{ - Use: "save-draft", - Short: "Save a Flow Draft", - Long: "Save a complete flow document as the current draft, replacing the existing draft. Pass `expectedVersion` as a query parameter to enable optimistic locking; the request fails with `409 Conflict` if the server-side version does not match. Omit `expectedVersion` to skip the check.\n\nScope: `cjp:config_write`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/v2/flows/{flowId}") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("expectedVersion", expectedVersion) - req.QueryParam("flowType", flowType) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "Flow ID.") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&expectedVersion, "expected-version", "", "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") - cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") - flowsCmd.AddCommand(cmd) - } - - { // patch-draft - var orgid string - var flowId string - var expectedVersion string - var flowType string - var bodyRaw string - var bodyFile string - cmd := &cobra.Command{ - Use: "patch-draft", - Short: "Patch a Flow Draft", - Long: "Apply partial updates to an existing flow draft without replacing the entire document. The patch body is a Patch Draft Contract \u2014 server-side merge, idempotent, and re-validated after the merge. The patch is rejected if the merged document fails validation, so the draft is never left in a broken state. The body may also include top-level overrides such as `name` and `description`.\n\nPass `expectedVersion` as a query parameter to enable optimistic locking; the request fails with `409 Conflict` if the server-side version does not match. Omit `expectedVersion` to skip the check.\n\nScope: `cjp:config_write`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "PATCH", "/flow-store/{orgid}/project/{projectId}/v2/flows/{flowId}") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("expectedVersion", expectedVersion) - req.QueryParam("flowType", flowType) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "Flow ID.") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&expectedVersion, "expected-version", "", "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") - cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") - flowsCmd.AddCommand(cmd) - } - - { // validate-draft - var orgid string - var flowId string - var versionId string - var flowType string - cmd := &cobra.Command{ - Use: "validate-draft", - Short: "Validate an Existing Flow Draft", - Long: "Validate the current draft of an existing flow (read-only operation).\n\nScope: `cjp:config_read`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/flows/{flowId}:validate") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("versionId", versionId) - req.QueryParam("flowType", flowType) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&versionId, "version-id", "", "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - flowsCmd.AddCommand(cmd) - } - - { // export - var orgid string - var flowId string - var version string - var flowType string - cmd := &cobra.Command{ - Use: "export", - Short: "Export a Flow", - Long: "Export a flow as a flow document for backup, migration, or version control.\n\nScope: `cjp:config_read`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/flows/{flowId}:export") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("version", version) - req.QueryParam("flowType", flowType) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&version, "version", "", "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - flowsCmd.AddCommand(cmd) - } - - { // list-2 - var orgid string - var flowType string - var ids string - var page string - var partialNameSearch string - var searchBy string - var size string - var includePagination string - var isValidation string - cmd := &cobra.Command{ - Use: "list-2", - Short: "List Flows or Subflows", - Long: "Returns a list of flows in response. Channel-based filtering can be applied with the `searchBy` query parameter (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`). Channel visibility may be constrained by organization feature flags. If associatedChannels key is missing or empty, it will be treated as telephony flow.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/flows") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.QueryParam("flowType", flowType) - req.QueryParam("ids", ids) - req.QueryParam("ids", ids) - req.QueryParam("page", page) - req.QueryParam("partialNameSearch", partialNameSearch) - req.QueryParam("searchBy", searchBy) - req.QueryParam("size", size) - req.QueryParam("includePagination", includePagination) - req.QueryParam("isValidation", isValidation) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - cmd.Flags().StringVar(&ids, "ids", "", "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.") - cmd.Flags().StringVar(&page, "page", "", "Defines the number of the displayed page. The page number starts from 0.") - cmd.Flags().StringVar(&partialNameSearch, "partial-name-search", "", "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.") - cmd.Flags().StringVar(&searchBy, "search-by", "", "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).") - cmd.Flags().StringVar(&size, "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(&includePagination, "include-pagination", "", "If set 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\".") - cmd.Flags().StringVar(&isValidation, "is-validation", "", "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.") - flowsCmd.AddCommand(cmd) - } - - { // publish-2 - var orgid string - var flowId string - var skipValidation string - var flowType string - var trackingId string - var comment string - var tagIds []string - var bodyRaw string - var bodyFile string - cmd := &cobra.Command{ - Use: "publish-2", - Short: "Publish a Flow or Subflow", - Long: "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_write`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/flows/{flowId}:publish") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("skipValidation", skipValidation) - req.QueryParam("flowType", flowType) - req.Header("TrackingId", trackingId) - if bodyFile != "" { - if err := req.SetBodyFile(bodyFile); err != nil { - return err - } - } else if bodyRaw != "" { - req.SetBodyRaw(bodyRaw) - } else { - req.BodyString("comment", comment) - req.BodyStringSlice("tagIds", tagIds) - } - resp, statusCode, err := req.Do() - if err != nil { - return err - } - return output.Print(resp, statusCode) - }, - } - cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&skipValidation, "skip-validation", "", "If true, the flow's pre-publish validation is skipped. Use with care.") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - cmd.Flags().StringVar(&trackingId, "tracking-id", "", "ID for tracking.") - cmd.Flags().StringVar(&comment, "comment", "", "") - cmd.Flags().StringSliceVar(&tagIds, "tag-ids", nil, "") - cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") - cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") - flowsCmd.AddCommand(cmd) - } - - { // lock-2 - var orgid string - var flowId string - var flowType string - cmd := &cobra.Command{ - Use: "lock-2", - Short: "Lock a Flow or Subflow", - Long: "Lock a flow to prevent concurrent edits by other users. Locks expire after 15 minutes of inactivity.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/flows/{flowId}:lock") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("flowType", flowType) - resp, statusCode, err := req.Do() - if err != nil { - return err - } - return output.Print(resp, statusCode) - }, - } - cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - flowsCmd.AddCommand(cmd) - } - - { // unlock-2 - var orgid string - var flowId string - var flowType string - cmd := &cobra.Command{ - Use: "unlock-2", - Short: "Unlock a Flow or Subflow", - Long: "Release the lock on a flow to allow other users to edit it.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/flows/{flowId}:unlock") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("flowType", flowType) - resp, statusCode, err := req.Do() - if err != nil { - return err - } - return output.Print(resp, statusCode) - }, - } - cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - flowsCmd.AddCommand(cmd) - } - - { // validate-2 - var orgid string - var bodyRaw string - var bodyFile string - cmd := &cobra.Command{ - Use: "validate-2", - Short: "Validate a Flow or Subflow", - Long: "Dry-run validate a flow/subflow definition without persisting it. Use this to check correctness before importing. Include `associatedChannels` to preserve the channel metadata that import and export payloads round-trip. Validation requests where `associatedChannels` is missing or empty are treated as telephony flows, and dry-run validation does not derive the effective channel from `associatedChannels`.\n\nNote: validation is more lenient than import. A flow that passes `:validate` can still be rejected by `:import` (for example, a missing start activity), so a successful validation does not guarantee a successful import.\n\nScope: `cjp:config_write`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/v2/flows:validate") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") - cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") - flowsCmd.AddCommand(cmd) - } - - { // import-2 - var orgid string - var overwrite string - var flowType string - var bodyRaw string - var bodyFile string - cmd := &cobra.Command{ - Use: "import-2", - Short: "Import a Flow or Subflow", - Long: "Import a new flow/subflow from a flow definition. Creates the flow/subflow in draft state and returns the assigned flow metadata, including `flowId`. Include `associatedChannels` in the payload when the flow contains channel-specific activities (for example, `customMessaging`) so channel references can be resolved correctly during import. If `associatedChannels` is missing or empty, the import is treated as a telephony flow. For `FLOW` imports, blank or whitespace-only `associatedChannels[].channelType` values are rejected.\n\nScope: `cjp:config_write`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/v2/flows:import") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.QueryParam("overwrite", overwrite) - req.QueryParam("flowType", flowType) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&overwrite, "overwrite", "", "If true, replaces an existing flow with the same name. Defaults to false.") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") - cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") - flowsCmd.AddCommand(cmd) - } - - { // get-2 - var orgid string - var flowId string - var flowType string - cmd := &cobra.Command{ - Use: "get-2", - Short: "Get a Flow or Subflow", - Long: "Retrieve the current draft of a flow/subflow as a flow document. To fetch a specific published version, use the `:export` endpoint. The response includes channel metadata (for example, `associatedChannels`) used by channel-specific activities such as `customMessaging`. If `associatedChannels` is missing or empty, the flow is treated as telephony.\n\nScope: `cjp:config_read`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/flows/{flowId}") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("flowType", flowType) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "Flow ID.") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - flowsCmd.AddCommand(cmd) - } - - { // save-draft-2 - var orgid string - var flowId string - var expectedVersion string - var flowType string - var bodyRaw string - var bodyFile string - cmd := &cobra.Command{ - Use: "save-draft-2", - Short: "Save a Flow or Subflow Draft", - Long: "Save a complete flow/subflow document as the current draft, replacing the existing draft. Submitted `associatedChannels` values are not persisted on save; the draft preserves the existing stored channel metadata. Omitting `associatedChannels` does not default an existing flow to telephony. Pass `expectedVersion` as a query parameter to enable optimistic locking; the request fails with `409 Conflict` if the server-side version does not match. Omit `expectedVersion` to skip the check.\n\nScope: `cjp:config_write`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "POST", "/{orgid}/project/{projectId}/v2/flows/{flowId}") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("expectedVersion", expectedVersion) - req.QueryParam("flowType", flowType) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "Flow ID.") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&expectedVersion, "expected-version", "", "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") - cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") - flowsCmd.AddCommand(cmd) - } - - { // patch-draft-2 - var orgid string - var flowId string - var expectedVersion string - var flowType string - var bodyRaw string - var bodyFile string - cmd := &cobra.Command{ - Use: "patch-draft-2", - Short: "Patch a Flow or Subflow Draft", - Long: "Apply partial updates to an existing flow/subflow draft without replacing the entire document. The patch body is a Patch Draft Contract \u2014 server-side merge, idempotent, and re-validated after the merge. The patch is rejected if the merged document fails validation, so the draft is never left in a broken state. The body may also include top-level overrides such as `name` and `description`. Submitted `associatedChannels` values are not persisted on patch; the draft preserves the existing stored channel metadata.\n\nPass `expectedVersion` as a query parameter to enable optimistic locking; the request fails with `409 Conflict` if the server-side version does not match. Omit `expectedVersion` to skip the check.\n\nScope: `cjp:config_write`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "PATCH", "/{orgid}/project/{projectId}/v2/flows/{flowId}") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("expectedVersion", expectedVersion) - req.QueryParam("flowType", flowType) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "Flow ID.") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&expectedVersion, "expected-version", "", "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") - cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") - flowsCmd.AddCommand(cmd) - } - - { // validate-draft-2 - var orgid string - var flowId string - var versionId string - var flowType string - cmd := &cobra.Command{ - Use: "validate-draft-2", - Short: "Validate an Existing Flow or Subflow Draft", - Long: "Validate the current draft of an existing flow/subflow (read-only operation). Validation reads the draft as stored. Drafts where `associatedChannels` is missing or empty are treated as telephony flows, and validation does not derive the effective channel from `associatedChannels`.\n\nScope: `cjp:config_read`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/flows/{flowId}:validate") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("versionId", versionId) - req.QueryParam("flowType", flowType) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&versionId, "version-id", "", "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - flowsCmd.AddCommand(cmd) - } - - { // export-2 - var orgid string - var flowId string - var version string - var flowType string - cmd := &cobra.Command{ - Use: "export-2", - Short: "Export a Flow or Subflow", - Long: "Export a flow/subflow as a flow document for backup, migration, or version control. The exported payload includes `associatedChannels` metadata to preserve channel-specific activity behavior (for example, `customMessaging`) during re-import. If `associatedChannels` is missing or empty, the flow is treated as telephony.\n\nScope: `cjp:config_read`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/v2/flows/{flowId}:export") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("version", version) - req.QueryParam("flowType", flowType) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&version, "version", "", "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - flowsCmd.AddCommand(cmd) - } - - { // search - var orgid string - var query string - var flowType string - var page string - var size string - var keyValueFilter string - cmd := &cobra.Command{ - Use: "search", - Short: "Search Flows", - Long: "Returns a list of flows in response. The search is case-sensitive.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/{orgid}/project/{projectId}/flows:search") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.QueryParam("query", query) - req.QueryParam("flowType", flowType) - req.QueryParam("page", page) - req.QueryParam("size", size) - req.QueryParam("keyValueFilter", keyValueFilter) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&query, "query", "", "Searches for flows with the given query. The search is case-sensitive.") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW' or 'ALL'. Default value is 'ALL'.") - cmd.Flags().StringVar(&page, "page", "", "Defines the number of the displayed page. The page number starts from 0.") - cmd.Flags().StringVar(&size, "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(&keyValueFilter, "key-value-filter", "", "Filters results based on key-value pairs. Format: 'key1|value1,key2|value2'. This will add a filter on normalizedFlow collection directly instead of running query on atlas.") - flowsCmd.AddCommand(cmd) - } - - { // delete - var orgid string - var flowId string - var force string - var skipRsEpcheck string - var flowType string - cmd := &cobra.Command{ - Use: "delete", - Short: "Delete a Flow or Subflow", - Long: "Permanently deletes a flow or subflow. Flows deleted via this API are removed permanently and cannot be recovered.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "DELETE", "/{orgid}/project/{projectId}/flows/{flowId}") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("force", force) - req.QueryParam("skipRsEPCheck", skipRsEpcheck) - req.QueryParam("flowType", flowType) - resp, statusCode, err := req.Do() - if err != nil { - return err - } - return output.Print(resp, statusCode) - }, - } - cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "ID of the flow/subflow to delete.") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&force, "force", "", "If 'yes', the flow is deleted even if it is still referenced by other entities. Defaults to 'no'.") - cmd.Flags().StringVar(&skipRsEpcheck, "skip-rs-epcheck", "", "If true, skips the check for routing strategy and entry point associations before deleting the flow.") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - flowsCmd.AddCommand(cmd) - } - -} diff --git a/cmd/cc/functions.go b/cmd/cc/functions.go index 9d0d723..f11c6e4 100644 --- a/cmd/cc/functions.go +++ b/cmd/cc/functions.go @@ -29,7 +29,7 @@ var functionsCmd = &cobra.Command{ func init() { cmd.CcCmd.AddCommand(functionsCmd) - { // list-custom + { // list var orgid string var isPartialMatch string var isCaseSensitive string @@ -43,7 +43,7 @@ func init() { var fields string var isValidation string cmd := &cobra.Command{ - Use: "list-custom", + Use: "list", Short: "List Custom Functions", Long: "List or search custom functions in the organization. Without filters, returns all custom functions. Supports filtering by name, language, and status, plus sorting and pagination.\n\nScope: `cjp:config_read`", RunE: func(cmd *cobra.Command, args []string) error { @@ -90,12 +90,12 @@ func init() { functionsCmd.AddCommand(cmd) } - { // create-custom + { // create var orgid string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "create-custom", + Use: "create", Short: "Create a Custom Function", Long: "Create a new custom function. The source code is provided as an escaped string and the runtime defaults to the highest supported runtime for the given language.\n\nScope: `cjp:config_write`", RunE: func(cmd *cobra.Command, args []string) error { @@ -122,13 +122,13 @@ func init() { functionsCmd.AddCommand(cmd) } - { // get-custom + { // get var orgid string var id string var versionOrTag string var metaDataOnly string cmd := &cobra.Command{ - Use: "get-custom", + Use: "get", Short: "Get a Custom Function", Long: "Retrieve a custom function by its ID. Use `versionOrTag` to fetch a specific published version, or omit it to get the draft.\n\nScope: `cjp:config_read`", RunE: func(cmd *cobra.Command, args []string) error { @@ -160,13 +160,13 @@ func init() { functionsCmd.AddCommand(cmd) } - { // update-custom + { // update var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-custom", + Use: "update", Short: "Update a Custom Function", Long: "Update an existing custom function by ID. Replaces the draft source code and metadata with the supplied body.\n\nScope: `cjp:config_write`", RunE: func(cmd *cobra.Command, args []string) error { @@ -196,12 +196,12 @@ func init() { functionsCmd.AddCommand(cmd) } - { // delete-custom + { // delete var orgid string var id string var isForceDeletion string cmd := &cobra.Command{ - Use: "delete-custom", + Use: "delete", Short: "Delete a Custom Function", Long: "Delete a custom function by ID. Use `isForceDeletion=true` to delete even when the function is referenced by one or more flows.\n\nScope: `cjp:config_write`", RunE: func(cmd *cobra.Command, args []string) error { @@ -224,12 +224,12 @@ func init() { functionsCmd.AddCommand(cmd) } - { // import-custom + { // import var orgid string var overwrite string var associatedRcs string cmd := &cobra.Command{ - Use: "import-custom", + Use: "import", Short: "Import a Custom Function", Long: "Import a custom function from a previously exported function-definition JSON file, uploaded as the multipart `file` part (not a zip or base64 envelope). Use `overwrite=true` to replace any existing function with the same name.\n\nScope: `cjp:config_write`", RunE: func(cmd *cobra.Command, args []string) error { @@ -252,11 +252,11 @@ func init() { functionsCmd.AddCommand(cmd) } - { // unlock-custom + { // unlock var orgid string var id string cmd := &cobra.Command{ - Use: "unlock-custom", + Use: "unlock", Short: "Unlock a Custom Function", Long: "Release the edit lock on a custom function so that other users can edit it.\n\nScope: `cjp:config_write`", RunE: func(cmd *cobra.Command, args []string) error { @@ -277,11 +277,11 @@ func init() { functionsCmd.AddCommand(cmd) } - { // lock-custom + { // lock var orgid string var id string cmd := &cobra.Command{ - Use: "lock-custom", + Use: "lock", Short: "Lock a Custom Function", Long: "Acquire an edit lock on a custom function to prevent concurrent writes by other users.\n\nScope: `cjp:config_write`", RunE: func(cmd *cobra.Command, args []string) error { @@ -302,13 +302,13 @@ func init() { functionsCmd.AddCommand(cmd) } - { // test-custom + { // test var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "test-custom", + Use: "test", Short: "Test a Custom Function", Long: "Execute a custom function with a test payload. Implicitly publishes the latest draft first, so the run uses the most recent source code.\n\nScope: `cjp:config_write`", RunE: func(cmd *cobra.Command, args []string) error { @@ -338,7 +338,7 @@ func init() { functionsCmd.AddCommand(cmd) } - { // publish-custom + { // publish var orgid string var id string var tags []string @@ -350,7 +350,7 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "publish-custom", + Use: "publish", Short: "Publish a Custom Function", Long: "Publish the latest draft of a custom function under one or more tags (`Dev`, `Test`, `Latest`, `Live`). Ensure the function has been created or updated before calling this API.\n\nScope: `cjp:config_write`", RunE: func(cmd *cobra.Command, args []string) error { @@ -393,12 +393,12 @@ func init() { functionsCmd.AddCommand(cmd) } - { // export-custom + { // export var orgid string var id string var versionOrTag string cmd := &cobra.Command{ - Use: "export-custom", + Use: "export", Short: "Export a Custom Function", Long: "Export a custom function for the given version or publish tag. Returns the plain function-definition JSON (name, language, runtime, description, source code, inputs, and outputs), suitable for re-importing via the import API.\n\nScope: `cjp:config_read`", RunE: func(cmd *cobra.Command, args []string) error { diff --git a/cmd/cc/legacy_flows.go b/cmd/cc/legacy_flows.go deleted file mode 100644 index 2e64750..0000000 --- a/cmd/cc/legacy_flows.go +++ /dev/null @@ -1,98 +0,0 @@ -// Code generated by codegen/generate_cli.py; DO NOT EDIT. - -package cc - -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 legacyFlowsCmd = &cobra.Command{ - Use: "legacy-flows", - Short: "LegacyFlows commands", -} - -func init() { - cmd.CcCmd.AddCommand(legacyFlowsCmd) - - { // export - var orgid string - var flowId string - var version string - var flowType string - cmd := &cobra.Command{ - Use: "export", - Short: "Export a Flow or Subflow", - Long: "**Deprecated.** Use the Flow export endpoint (`GET /flow-store/{orgId}/project/{projectId}/v2/flows/{flowId}:export`, operationId `exportFlowV2`) instead. The V1 Flow APIs operate on the raw FDL format and will continue to function but will not receive new features.\n\nReturns the exported flow/subflow in response, including associated channel metadata used to preserve channel-specific activity behavior during export and re-import.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/flows/{flowId}:export") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.PathParam("flowId", flowId) - req.QueryParam("version", version) - req.QueryParam("flowType", flowType) - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&flowId, "flow-id", "", "") - cmd.MarkFlagRequired("flow-id") - cmd.Flags().StringVar(&version, "version", "", "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - legacyFlowsCmd.AddCommand(cmd) - } - - { // import - var orgid string - var overwrite string - var flowType string - var contentLength string - cmd := &cobra.Command{ - Use: "import", - Short: "Import a Flow or Subflow", - Long: "**Deprecated.** Use the Flow import endpoint (`POST /flow-store/{orgId}/project/{projectId}/v2/flows:import`, operationId `importFlowV2`) instead. The V1 Flow APIs operate on the raw FDL format and will continue to function but will not receive new features.\n\nReturns the imported flow/subflow in response.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "POST", "/flow-store/{orgid}/project/{projectId}/flows:import") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - req.QueryParam("overwrite", overwrite) - req.QueryParam("flowType", flowType) - req.Header("Content-Length", contentLength) - resp, statusCode, err := req.Do() - if err != nil { - return err - } - return output.Print(resp, statusCode) - }, - } - cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&overwrite, "overwrite", "", "Determines whether to overwrite the existing flow or not. Possible values: yes/no.") - cmd.Flags().StringVar(&flowType, "flow-type", "", "Either of 'FLOW' or 'SUBFLOW'.") - cmd.Flags().StringVar(&contentLength, "content-length", "", "Content length value in number of bytes.") - legacyFlowsCmd.AddCommand(cmd) - } - -} diff --git a/cmd/cc/outdial_ani.go b/cmd/cc/outdial_ani.go index 2140e49..f210d77 100644 --- a/cmd/cc/outdial_ani.go +++ b/cmd/cc/outdial_ani.go @@ -180,9 +180,10 @@ func init() { var page string var pageSize string cmd := &cobra.Command{ - Use: "list-entries", - Short: "List Outdial ANI Entries", - Long: `Retrieve a list of Outdial ANI Entries in a given organization.`, + Use: "list-entries", + Aliases: []string{"list-entry"}, + Short: "List Outdial ANI Entries", + Long: `Retrieve a list of Outdial ANI Entries in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/outdial-ani/entry") req.PathParam("orgid", orgid) @@ -416,9 +417,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "bulk-save-entries", - Short: "Bulk save Outdial ANI Entries", - Long: `Create, Update or delete Outdial ANI Entries in bulk for an Address Book in a given organization.`, + Use: "bulk-save-entries", + Aliases: []string{"bulk-save-entry"}, + Short: "Bulk save Outdial ANI Entries", + Long: `Create, Update or delete Outdial ANI Entries in bulk for an Address Book in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/outdial-ani/{outDialAniId}/entry/bulk") req.PathParam("orgid", orgid) @@ -574,7 +576,7 @@ func init() { outdialAniCmd.AddCommand(cmd) } - { // list-entries-2 + { // list-entries-for-ani var orgid string var outDialAniId string var filter string @@ -583,9 +585,10 @@ func init() { var page string var pageSize string cmd := &cobra.Command{ - Use: "list-entries-2", - Short: "List Outdial ANI Entries", - Long: `Retrieve a list of Outdial ANI Entries in a given organization.`, + Use: "list-entries-for-ani", + Aliases: []string{"list-entry-2"}, + Short: "List Outdial ANI Entries", + Long: `Retrieve a list of Outdial ANI Entries in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/outdial-ani/{outDialAniId}/entry") req.PathParam("orgid", orgid) diff --git a/cmd/cc/tasks.go b/cmd/cc/tasks.go index fc71664..7be8a0e 100644 --- a/cmd/cc/tasks.go +++ b/cmd/cc/tasks.go @@ -265,9 +265,10 @@ If the header is not present in the request or if gzip is not listed as one of t var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "unhold", - Short: "Unhold Task", - Long: `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).`, + Use: "unhold", + Aliases: []string{"resume"}, + Short: "Unhold Task", + Long: `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).`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/v1/tasks/{taskId}/unhold") req.PathParam("taskId", taskId) @@ -729,9 +730,10 @@ If the header is not present in the request or if gzip is not listed as one of t var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "append-message", - Short: "Append Task Message", - Long: "This feature is currently in Beta. Contact your Cisco team if you want access to this feature.\n\nAppends an inbound message to an existing `workItem` or `customMessaging` task. Use this API after the initial task has been created through Create Task. Requires `cjp:task_write` OAuth scope. For partner-initiated inbound message appends, the `cjp:task_write` scope must be present in the partner application's access token.\n\nOn success, returns a `202` response containing the append event identifier as `data.id`. Partners can use this identifier to correlate subsequent webhook delivery for the appended message.", + Use: "append-message", + Aliases: []string{"update-2"}, + Short: "Append Task Message", + Long: "This feature is currently in Beta. Contact your Cisco team if you want access to this feature.\n\nAppends an inbound message to an existing `workItem` or `customMessaging` task. Use this API after the initial task has been created through Create Task. Requires `cjp:task_write` OAuth scope. For partner-initiated inbound message appends, the `cjp:task_write` scope must be present in the partner application's access token.\n\nOn success, returns a `202` response containing the append event identifier as `data.id`. Partners can use this identifier to correlate subsequent webhook delivery for the appended message.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/v2/tasks/{taskId}/messages") req.PathParam("taskId", taskId) @@ -781,10 +783,10 @@ If the header is not present in the request or if gzip is not listed as one of t tasksCmd.AddCommand(cmd) } - { // pause + { // pause-digital var taskId string cmd := &cobra.Command{ - Use: "pause", + Use: "pause-digital", Short: "Pause Task", Long: "Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to pause a task that cannot be handled immediately. This API is supported only for non-real-time digital channels, such as email, social, etc. Authorization requires the `cjp:user` scope. For a list of potential response messages, refer to the [Call Control API Guide](/docs/contact-control-apis).", RunE: func(cmd *cobra.Command, args []string) error { @@ -802,10 +804,10 @@ If the header is not present in the request or if gzip is not listed as one of t tasksCmd.AddCommand(cmd) } - { // resume + { // resume-digital var taskId string cmd := &cobra.Command{ - Use: "resume", + Use: "resume-digital", Short: "Resume Task", Long: "Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to resume a previously paused task. This API is supported only for non-real-time digital channels, such as email, social, etc. Authorization requires the `cjp:user` scope. For a list of potential response messages, refer to the [Call Control API Guide](/docs/contact-control-apis).", RunE: func(cmd *cobra.Command, args []string) error { diff --git a/cmd/cc/templates.go b/cmd/cc/templates.go index 2411d8f..74430fa 100644 --- a/cmd/cc/templates.go +++ b/cmd/cc/templates.go @@ -26,16 +26,13 @@ func init() { cmd.CcCmd.AddCommand(templatesCmd) { // list-flow - var orgid string var typeVal string cmd := &cobra.Command{ Use: "list-flow", Short: "List Flow Templates", Long: "List available flow templates that can be used to create new flows.\n\nScope: `cjp:config_read`", RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/templates") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") + req := client.NewRequest(config.CcBaseURL, "GET", "/templates") req.QueryParam("type", typeVal) if config.Paginate() { resp, statusCode, err := req.DoPaginated(false) @@ -51,78 +48,16 @@ func init() { return output.Print(resp, statusCode) }, } - cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID.") - cmd.MarkFlagRequired("orgid") cmd.Flags().StringVar(&typeVal, "type", "", "Filter by flow or subflow.") templatesCmd.AddCommand(cmd) } { // get-flow - var orgid string var id string cmd := &cobra.Command{ Use: "get-flow", Short: "Get a Flow Template", Long: "Retrieve a specific flow template by its ID. Use this to inspect a template's flow structure before creating a flow from it.\n\nScope: `cjp:config_read`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/flow-store/{orgid}/project/{projectId}/v2/templates/{id}") - req.PathParam("orgid", orgid) - req.PathParam("projectId", "5e5c9ad6d61f870d6d778c1b") - 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.") - cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&id, "id", "", "Template ID.") - cmd.MarkFlagRequired("id") - templatesCmd.AddCommand(cmd) - } - - { // list-flow-2 - var typeVal string - cmd := &cobra.Command{ - Use: "list-flow-2", - Short: "List Flow Templates", - Long: "List available flow templates that can be used to create new flows.\n\nScope: `cjp:config_read`", - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "GET", "/templates") - req.QueryParam("type", typeVal) - 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(&typeVal, "type", "", "Filter by flow or subflow.") - templatesCmd.AddCommand(cmd) - } - - { // get-flow-2 - var id string - cmd := &cobra.Command{ - Use: "get-flow-2", - Short: "Get a Flow Template", - Long: "Retrieve a specific flow template by its ID. Use this to inspect a template's flow structure before creating a flow from it.\n\nScope: `cjp:config_read`", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/templates/{id}") req.PathParam("id", id) diff --git a/cmd/cc/usage_reports.go b/cmd/cc/usage_reports.go index 05eb7a1..1c6d075 100644 --- a/cmd/cc/usage_reports.go +++ b/cmd/cc/usage_reports.go @@ -25,9 +25,9 @@ var usageReportsCmd = &cobra.Command{ func init() { cmd.CcCmd.AddCommand(usageReportsCmd) - { // get-available-types + { // list-resource-types cmd := &cobra.Command{ - Use: "get-available-types", + Use: "list-resource-types", Short: "Get available resource types", Long: `Returns the list of available resource types that can be used for report generation, along with available data dates.`, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/cmd/cc/users.go b/cmd/cc/users.go index 839901f..7c54f24 100644 --- a/cmd/cc/users.go +++ b/cmd/cc/users.go @@ -241,7 +241,7 @@ func init() { usersCmd.AddCommand(cmd) } - { // list-2 + { // list-by-ids var orgid string var page string var pageSize string @@ -251,9 +251,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "list-2", - Short: "List Users with details", - Long: `Retrieve an existing User's first name, last name and email by list of IDs in a given organization.`, + Use: "list-by-ids", + Aliases: []string{"get-ids"}, + Short: "List Users with details", + 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") req.PathParam("orgid", orgid) @@ -525,9 +526,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "bulk-partial-update-dynamic-skills", - Short: "Bulk partial update Users with dynamic skills", - Long: `Assign or unassign a dynamic skill to/from multiple users in bulk for a given organization.`, + Use: "bulk-partial-update-dynamic-skills", + Aliases: []string{"bulk-update-dynamic-skills"}, + Short: "Bulk partial update Users with 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) diff --git a/cmd/messaging/hds.go b/cmd/messaging/hds.go index d9d998b..c8fa3e4 100644 --- a/cmd/messaging/hds.go +++ b/cmd/messaging/hds.go @@ -20,8 +20,9 @@ var _ = output.Print var _ = timeutil.ParseLastISO var hdsCmd = &cobra.Command{ - Use: "hds", - Short: "Hds commands", + Use: "hds", + Aliases: []string{"hybrid-data-security"}, + Short: "Hds commands", } func init() { @@ -249,11 +250,12 @@ To obtain the Cluster ID needed for this API, use the [Get organization details hdsCmd.AddCommand(cmd) } - { // get-database-org-2 + { // get-database-config-org var organizationId string cmd := &cobra.Command{ - Use: "get-database-org-2", - Short: "Get database details for the HDS organization", + Use: "get-database-config-org", + Aliases: []string{"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 { @@ -278,11 +280,12 @@ To obtain the Organization ID needed for this API, use the [Organizations API](< hdsCmd.AddCommand(cmd) } - { // get-multi-tenant-org-2 + { // list-tenants-org var organizationId string cmd := &cobra.Command{ - Use: "get-multi-tenant-org-2", - Short: "Get Multi-Tenant HDS organization details", + Use: "list-tenants-org", + Aliases: []string{"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 { diff --git a/cmd/messaging/hybrid_data_security.go b/cmd/messaging/hybrid_data_security.go deleted file mode 100644 index 675d3ab..0000000 --- a/cmd/messaging/hybrid_data_security.go +++ /dev/null @@ -1,398 +0,0 @@ -// Code generated by codegen/generate_cli.py; DO NOT EDIT. - -package messaging - -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/Cloverhound/webex-cli/internal/timeutil" - "github.com/spf13/cobra" -) - -// Ensure imports are used. -var _ = fmt.Sprintf -var _ = config.Token -var _ = output.Print -var _ = timeutil.ParseLastISO - -var hybridDataSecurityCmd = &cobra.Command{ - Use: "hybrid-data-security", - Short: "HybridDataSecurity commands", -} - -func init() { - cmd.MessagingCmd.AddCommand(hybridDataSecurityCmd) - - { // get-org - var organizationId string - cmd := &cobra.Command{ - Use: "get-org", - Short: "Get organization details", - Long: `Retrieve details for an Hybrid Data Security organization, such as the organization name, type of organization. -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}") - 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 Hybrid Data Security organization.") - cmd.MarkFlagRequired("organization-id") - hybridDataSecurityCmd.AddCommand(cmd) - } - - { // list-clusters-org - var organizationId string - cmd := &cobra.Command{ - Use: "list-clusters-org", - Short: "List clusters for an Hybrid Data Security organization", - Long: `Retrieve a list of all clusters for a specific Hybrid Data Security organization, including cluster status, release channel, and upgrade schedule details. -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}/clusters") - 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 Hybrid Data Security organization.") - cmd.MarkFlagRequired("organization-id") - hybridDataSecurityCmd.AddCommand(cmd) - } - - { // get-cluster - var clusterId string - cmd := &cobra.Command{ - Use: "get-cluster", - Short: "Get cluster details", - Long: `Retrieve details for a specific Hybrid Data Security cluster, such as the cluster name, cluster status, upgrade schedule, and Hybrid Data Security nodes in the cluster. -To obtain the Cluster ID needed for this API, use the [Get organization details API]()`, - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/clusters/{clusterId}") - req.PathParam("clusterId", clusterId) - 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(&clusterId, "cluster-id", "", "Unique ID of the Hybrid Data Security cluster.") - cmd.MarkFlagRequired("cluster-id") - hybridDataSecurityCmd.AddCommand(cmd) - } - - { // list-nodes-cluster - var clusterId string - cmd := &cobra.Command{ - Use: "list-nodes-cluster", - Short: "List nodes for an Hybrid Data Security cluster", - Long: `Retrieve a list of all nodes for a specific Hybrid Data Security cluster, including availability, proxy details, deployment type, and release version. -To obtain the Cluster ID needed for this API, use the [List clusters for an Hybrid Data Security organization API]()`, - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/clusters/{clusterId}/nodes") - req.PathParam("clusterId", clusterId) - 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(&clusterId, "cluster-id", "", "Unique ID of the Hybrid Data Security cluster.") - cmd.MarkFlagRequired("cluster-id") - hybridDataSecurityCmd.AddCommand(cmd) - } - - { // get-node - var nodeId string - cmd := &cobra.Command{ - Use: "get-node", - Short: "Get node details", - Long: `Retrieve details for a specific Hybrid Data Security node, such as host name, release version, proxy details, deployment and build type, availability details, etc. -To obtain the Node ID needed for this API, use the [Get cluster details API]()`, - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/nodes/{nodeId}") - req.PathParam("nodeId", nodeId) - 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(&nodeId, "node-id", "", "Unique ID of the Hybrid Data Security node") - cmd.MarkFlagRequired("node-id") - hybridDataSecurityCmd.AddCommand(cmd) - } - - { // get-database-org - var organizationId string - cmd := &cobra.Command{ - Use: "get-database-org", - Short: "Get database details for the Hybrid Data Security organization", - Long: `Retrieve details of database information for an Hybrid Data Security 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 Hybrid Data Security organization") - cmd.MarkFlagRequired("organization-id") - hybridDataSecurityCmd.AddCommand(cmd) - } - - { // get-multi-tenant-org - var organizationId string - cmd := &cobra.Command{ - Use: "get-multi-tenant-org", - Short: "Get Multi-Tenant Hybrid Data Security organization details", - Long: `Retrieve details of Multi-Tenant Hybrid Data Security 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 Hybrid Data Security organization.") - cmd.MarkFlagRequired("organization-id") - hybridDataSecurityCmd.AddCommand(cmd) - } - - { // get-alarms-node - var nodeId string - var from string - var to string - var last string - cmd := &cobra.Command{ - Use: "get-alarms-node", - Short: "Get alarms for an Hybrid Data Security node", - Long: `Returns the alarm details for a single Hybrid Data Security node for the provided time range (last 24 hours). -To obtain the Node ID needed for this API, use the [List nodes for an Hybrid Data Security cluster API]()`, - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/nodes/{nodeId}/alarms") - if last != "" { - var err error - from, to, err = timeutil.ParseLastISO(last) - if err != nil { - return err - } - } - req.PathParam("nodeId", nodeId) - req.QueryParam("from", from) - req.QueryParam("to", to) - 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(&nodeId, "node-id", "", "Unique ID of the Hybrid Data Security node.") - cmd.MarkFlagRequired("node-id") - cmd.Flags().StringVar(&from, "from", "", "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.") - cmd.Flags().StringVar(&to, "to", "", "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.") - cmd.Flags().StringVar(&last, "last", "", "Time range shorthand (e.g. 1h, 30m, 24h). Sets --from automatically.") - hybridDataSecurityCmd.AddCommand(cmd) - } - - { // get-test-results-node - var nodeId string - var triggerType string - cmd := &cobra.Command{ - Use: "get-test-results-node", - Short: "Get test results for Hybrid Data Security node", - Long: `Get the latest results of the network tests triggered for a single Hybrid Data Security node. The test results are generated as part of the Network Test execution on the node. The network tests include the Bandwidth Test, DNS Resolution Test, and HTTPS Connectivity Test. - The results from the latest test run are provided, covering up to the past 90 days if available. -To obtain the Node ID needed for this API, use the [Get cluster details API]()`, - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/testResults/nodes/{nodeId}/networkTest") - req.PathParam("nodeId", nodeId) - req.QueryParam("triggerType", triggerType) - 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(&nodeId, "node-id", "", "Unique ID of the Hybrid Data Security node.") - cmd.MarkFlagRequired("node-id") - cmd.Flags().StringVar(&triggerType, "trigger-type", "", "Trigger type.") - hybridDataSecurityCmd.AddCommand(cmd) - } - - { // get-usage-node - var nodeId string - var from string - var to string - var last string - cmd := &cobra.Command{ - Use: "get-usage-node", - Short: "Get resource usage for an Hybrid Data Security node", - Long: `Retrieve CPU, memory, and disk resource usage details for a specific Hybrid Data Security node over the requested time range. -To obtain the Node ID needed for this API, use the [List nodes for an Hybrid Data Security cluster API]()`, - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/nodes/{nodeId}/resourceUsage") - if last != "" { - var err error - from, to, err = timeutil.ParseLastISO(last) - if err != nil { - return err - } - } - req.PathParam("nodeId", nodeId) - req.QueryParam("from", from) - req.QueryParam("to", to) - 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(&nodeId, "node-id", "", "Unique ID of the Hybrid Data Security node.") - cmd.MarkFlagRequired("node-id") - cmd.Flags().StringVar(&from, "from", "", "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.") - cmd.Flags().StringVar(&to, "to", "", "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.") - cmd.Flags().StringVar(&last, "last", "", "Time range shorthand (e.g. 1h, 30m, 24h). Sets --from automatically.") - hybridDataSecurityCmd.AddCommand(cmd) - } - - { // get-availability-cluster - var clusterId string - var from string - var to string - var last string - cmd := &cobra.Command{ - Use: "get-availability-cluster", - Short: "Get availability details for Hybrid Data Security cluster", - Long: `Get the availability details for an Hybrid Data Security cluster, where each segment specifies the start and end times, as well as the number of online, offline, and total nodes within that segment. -To obtain the Cluster ID needed for this API, use the [Get organization details API]()`, - RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/clusters/{clusterId}/availability") - if last != "" { - var err error - from, to, err = timeutil.ParseLastISO(last) - if err != nil { - return err - } - } - req.PathParam("clusterId", clusterId) - req.QueryParam("from", from) - req.QueryParam("to", to) - 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(&clusterId, "cluster-id", "", "Unique ID of the Hybrid Data Security cluster.") - cmd.MarkFlagRequired("cluster-id") - cmd.Flags().StringVar(&from, "from", "", "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time.") - cmd.Flags().StringVar(&to, "to", "", "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.") - cmd.Flags().StringVar(&last, "last", "", "Time range shorthand (e.g. 1h, 30m, 24h). Sets --from automatically.") - hybridDataSecurityCmd.AddCommand(cmd) - } - -} diff --git a/codegen/INVENTORY.md b/codegen/INVENTORY.md new file mode 100644 index 0000000..a0fc75b --- /dev/null +++ b/codegen/INVENTORY.md @@ -0,0 +1,198 @@ +# Postman refresh inventory + +Compared with PR base `85b6a523894c82bb6b8440a103b6f05d39762312`. Added names include renamed/moved operations, not only new Cisco APIs. See [NAMING.md](NAMING.md) for migration details and live route checks. + +## Coverage + +| Area | Groups | Spec operations | +| --- | ---: | ---: | +| `admin` | 39 | 149 | +| `calling` | 49 | 1111 | +| `cc` | 64 | 498 | +| `device` | 10 | 113 | +| `meetings` | 23 | 173 | +| `messaging` | 12 | 65 | + +Counts cover the normalized spec; handwritten commands and codegen exclusions can differ. Devices has no new endpoints. + +## admin + +### Added canonical names + +| Full command | Method and path | Purpose | +| --- | --- | --- | +| `webex admin archive-users query` | `GET /identity/organizations/{orgId}/v1/ArchivedUser` | Retrieves archived user information for the specified organization | +| `webex admin identity-org update-authentication-configuration-settings` | `PATCH /identity/organizations/{orgId}/authenticationConfig` | Update the authentication configuration details, by organizationID. | +| `webex admin identity-org update-password-policy` | `PATCH /identity/organizations/{orgId}/passwordPolicy` | Update Organization Password Policy, by organizationID. | +| `webex admin recordings query` | `POST /recordings/query` | Queries recordings with filters in the request body | +| `webex admin recordings query-admin-compliance-officer` | `POST /admin/recordings/query` | Queries recordings for an admin or compliance officer with filters in the request body | + +## calling + +### Added canonical names + +| Full command | Method and path | Purpose | +| --- | --- | --- | +| `webex calling call-controls-for-me answer` | `POST /telephony/calls/members/me/answer` | Answer an incoming call | +| `webex calling call-controls-for-me dial` | `POST /telephony/calls/members/me/dial` | Initiate an outbound call to a specified destination | +| `webex calling call-controls-for-me get` | `GET /telephony/calls/members/me/calls/{callId}` | Get the details of the specified active call for the user. | +| `webex calling call-controls-for-me hangup` | `POST /telephony/calls/members/me/hangup` | Hangup a call | +| `webex calling call-controls-for-me list` | `GET /telephony/calls/members/me/calls` | Get the list of details for all active calls associated with the user. | +| `webex calling metrics get-call-quality-stats` | `GET /v1/analytics/callQualityStats` | Returns aggregated Webex Calling call and media-quality statistics for the authenticated organization | + +## cc + +### Added canonical names + +| Full command | Method and path | Purpose | +| --- | --- | --- | +| `webex cc activities describe` | `GET /{orgId}/project/{projectId}/v2/activities/{activityName}` | Retrieve a single activity's full definition, including inputs, outputs, named ports, and the JSON Schema for its inputs — all returned inline. | +| `webex cc activities get-input-choices` | `GET /{orgId}/project/{projectId}/v2/activities/{activityName}/inputs/{inputName}/choices` | Resolve choices for an activity input | +| `webex cc activities list-definitions` | `GET /{orgId}/project/{projectId}/v2/activities` | List all available activity types with their full schemas, including inputs, outputs, ports, and descriptions | +| `webex cc agent-personal-greeting-files create` | `POST /organization/{orgid}/v2/agent-personal-greeting` | Create a new Greeting File in a given organization. | +| `webex cc agent-personal-greeting-files delete-id` | `DELETE /organization/{orgid}/v2/agent-personal-greeting/{id}` | Delete an existing Greeting File by ID in a given organization. | +| `webex cc agent-personal-greeting-files delete-references` | `POST /organization/{orgid}/agent-personal-greeting/delete-reference` | Removes all references of the specified agent (ciUserId) from greeting files in the given organization | +| `webex cc agent-personal-greeting-files get-id` | `GET /organization/{orgid}/v2/agent-personal-greeting/{id}` | Retrieve an existing Greeting File by ID in a given organization. | +| `webex cc agent-personal-greeting-files patch-id` | `PATCH /organization/{orgid}/v2/agent-personal-greeting/{id}` | Partially update Greeting File by ID in a given organization. | +| `webex cc agent-personal-greeting-files update-id` | `PUT /organization/{orgid}/v2/agent-personal-greeting/{id}` | Update an existing Greeting File by ID in a given organization. | +| `webex cc asset bulk-save` | `POST /organization/{orgid}/asset/bulk` | Create, Update or delete Assets in bulk in a given organization | +| `webex cc asset create` | `POST /organization/{orgid}/asset` | Create a new Asset in a given organization | +| `webex cc asset delete-id` | `DELETE /organization/{orgid}/asset/{id}` | Delete an existing Asset by ID in a given organization | +| `webex cc asset get-id` | `GET /organization/{orgid}/asset/{id}` | Retrieve an existing Asset by ID in a given organization | +| `webex cc asset list` | `GET /organization/{orgid}/v2/asset` | Retrieve a list of Assets in a given organization | +| `webex cc asset list-references` | `GET /organization/{orgid}/asset/{id}/incoming-references` | Retrieve a list of all entities that have reference to an existing Asset by ID in a given organization | +| `webex cc asset patch-id` | `PATCH /organization/{orgid}/asset/{id}` | Partially update Asset by ID in a given organization | +| `webex cc asset update-id` | `PUT /organization/{orgid}/asset/{id}` | Update an existing Asset by ID in a given organization | +| `webex cc call-monitoring whisper-coach-request` | `POST /v1/monitor/{interactionId}/coach` | This feature is currently in Beta | +| `webex cc campaign-group list` | `GET /v3/campaign-management/campaign-groups/{campaignGroupName}/campaigns` | Retrieves the list of campaigns that belong to the specified campaign group | +| `webex cc campaign-manager get-valid-times` | `GET /v1/organization/{orgId}/getValidCampaignTimes` | Gets valid campaign times for a campaign and agent | +| `webex cc channel bulk-save` | `POST /organization/{orgid}/channel/bulk` | Create, Update or delete Channels in bulk in a given organization. | +| `webex cc channel create` | `POST /organization/{orgid}/channel` | Create a new Channel in a given organization | +| `webex cc channel delete-id` | `DELETE /organization/{orgid}/channel/{id}` | Delete an existing Channel by ID in a given organization. | +| `webex cc channel get-id` | `GET /organization/{orgid}/channel/{id}` | Retrieve an existing Channel by ID in a given organization | +| `webex cc channel list` | `GET /organization/{orgid}/v2/channel` | Retrieve a list of Channels in a given organization | +| `webex cc channel list-references` | `GET /organization/{orgid}/channel/{id}/incoming-references` | Retrieve a list of all entities that have reference to an existing Channel by ID in a given organization | +| `webex cc channel patch-id` | `PATCH /organization/{orgid}/channel/{id}` | Partially update a channel by ID | +| `webex cc channel update-id` | `PUT /organization/{orgid}/channel/{id}` | Update an existing Channel by ID in a given organization. | +| `webex cc contact-list-management update-status-across-campaign-chain` | `PATCH /v3/campaign-management/campaigns/{campaignId}/contacts/{contactId}` | Synchronously closes the specified contacts and returns the outcome in the same response | +| `webex cc contact-service-queue delete-references` | `POST /organization/{orgid}/contact-service-queue/delete-reference` | Removes the references to the specified entities (such as teams, sites, or agents) from Contact Service Queues for a given organization. | +| `webex cc contact-service-queue list-by-dynamic-skills` | `POST /organization/{orgid}/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile` | Retrieve a list of skill-based Contact Service Queues that match the given dynamic skills and skill profile criteria in a given organization. | +| `webex cc contact-service-queue list-by-skill-profile` | `GET /organization/{orgid}/contact-service-queue/by-skill-profile-id/{id}` | Retrieve a list of skill-based Contact Service Queues associated with a given skill profile ID, accessible to authorized clients in a given organization. | +| `webex cc contact-service-queue list-by-user-skill-profile` | `POST /organization/{orgid}/contact-service-queue/fetch-by-userId-skillProfileId` | Retrieve a list of skill-based Contact Service Queues associated with the given skill profile ID and user ID combination in a given organization. | +| `webex cc contact-service-queue list-manually-assignable` | `POST /organization/{orgid}/contact-service-queue/fetch-manually-assignable-queues` | Retrieve a list of Contact Service Queues that are eligible for manual contact assignment based on the provided criteria in a given organization. | +| `webex cc contact-service-queue list-references` | `GET /organization/{orgid}/contact-service-queue/{id}/incoming-references` | Retrieve a list of all entities that have reference to an existing Contact Service Queue by ID in a given organization. | +| `webex cc events list-specifications` | `GET /{orgId}/project/{projectId}/v2/event-specifications` | List the event types available for use in `event_flows[]` | +| `webex cc external-data-updates update-task-global-variables` | `PUT /v1/data/updateExternal` | Updates numeric global variable values associated with a completed Webex Contact Center task | +| `webex cc flow delete` | `DELETE /{orgId}/project/{projectId}/flows/{flowId}` | Permanently deletes a flow or subflow | +| `webex cc flow export-legacy` | `GET /flow-store/{orgId}/project/{projectId}/flows/{flowId}:export` | Returns the exported flow/subflow in response. | +| `webex cc flow get` | `GET /{orgId}/project/{projectId}/v2/flows/{flowId}` | Retrieve the current draft of a flow/subflow as a flow document | +| `webex cc flow import-legacy` | `POST /flow-store/{orgId}/project/{projectId}/flows:import` | Returns the imported flow/subflow in response. | +| `webex cc flow lock` | `POST /{orgId}/project/{projectId}/flows/{flowId}:lock` | Lock a flow to prevent concurrent edits by other users | +| `webex cc flow patch-draft` | `PATCH /{orgId}/project/{projectId}/v2/flows/{flowId}` | Apply partial updates to an existing flow/subflow draft without replacing the entire document | +| `webex cc flow save-draft` | `POST /{orgId}/project/{projectId}/v2/flows/{flowId}` | Save a complete flow/subflow document as the current draft, replacing the existing draft | +| `webex cc flow search` | `GET /{orgId}/project/{projectId}/flows:search` | Returns a list of flows in response | +| `webex cc flow unlock` | `POST /{orgId}/project/{projectId}/flows/{flowId}:unlock` | Release the lock on a flow to allow other users to edit it. | +| `webex cc flow validate` | `POST /{orgId}/project/{projectId}/v2/flows:validate` | Dry-run validate a flow/subflow definition without persisting it | +| `webex cc flow validate-draft` | `GET /{orgId}/project/{projectId}/v2/flows/{flowId}:validate` | Validate the current draft of an existing flow/subflow (read-only operation) | +| `webex cc functions create` | `POST /v1/{orgId}/functions` | Create a new custom function | +| `webex cc functions delete` | `DELETE /v1/{orgId}/functions/{id}` | Delete a custom function by ID | +| `webex cc functions export` | `POST /v1/{orgId}/functions/{id}:export` | Export a custom function for the given version or publish tag | +| `webex cc functions get` | `GET /v1/{orgId}/functions/{id}` | Retrieve a custom function by its ID | +| `webex cc functions import` | `POST /v1/{orgId}/functions:import` | Import a custom function from a previously exported function-definition JSON file, uploaded as the multipart `file` part (not a zip or base64 envelope) | +| `webex cc functions list` | `GET /v1/{orgId}/functions` | List or search custom functions in the organization | +| `webex cc functions list-options` | `GET /v1/{orgId}/functions/options` | List the supported programming languages, runtimes, and corresponding wrapper code for custom functions | +| `webex cc functions lock` | `POST /v1/{orgId}/functions/{id}:lock` | Acquire an edit lock on a custom function to prevent concurrent writes by other users. | +| `webex cc functions publish` | `POST /v1/{orgId}/functions/{id}:publish` | Publish the latest draft of a custom function under one or more tags (`Dev`, `Test`, `Latest`, `Live`) | +| `webex cc functions test` | `POST /v1/{orgId}/functions/{id}:test` | Execute a custom function with a test payload | +| `webex cc functions unlock` | `POST /v1/{orgId}/functions/{id}:unlock` | Release the edit lock on a custom function so that other users can edit it. | +| `webex cc functions update` | `PUT /v1/{orgId}/functions/{id}` | Update an existing custom function by ID | +| `webex cc outdial-ani bulk-save-entries` | `POST /organization/{orgid}/outdial-ani/{outDialAniId}/entry/bulk` | Create, Update or delete Outdial ANI Entries in bulk for an Address Book in a given organization. | +| `webex cc outdial-ani list-entries` | `GET /organization/{orgid}/outdial-ani/entry` | Retrieve a list of Outdial ANI Entries in a given organization. | +| `webex cc outdial-ani list-entries-for-ani` | `GET /organization/{orgid}/v2/outdial-ani/{outDialAniId}/entry` | Retrieve a list of Outdial ANI Entries in a given organization. | +| `webex cc search-metadata get` | `GET /search/v2/meta` | Returns schema metadata for the Webex Contact Center Search GraphQL API, describing supported queries, fields, nested structures, data types, filters, sorting options, grouping capabilities, and aggregation operations. | +| `webex cc tasks append-message` | `POST /v2/tasks/{taskId}/messages` | This feature is currently in Beta | +| `webex cc tasks drop-participant-conference` | `POST /v1/tasks/{taskId}/conference/participants/{participantId}/drop` | Access this endpoint when the user needs to drop a specific participant from an active conference associated with a task | +| `webex cc tasks pause-digital` | `POST /v1/tasks/{taskId}/pause` | Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to pause a task that cannot be handled immediately | +| `webex cc tasks resume-digital` | `POST /v1/tasks/{taskId}/resume` | Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to resume a previously paused task | +| `webex cc tasks unhold` | `POST /v1/tasks/{taskId}/unhold` | Access this endpoint when the user has to resume a call from hold | +| `webex cc templates get-flow` | `GET /templates/{id}` | Retrieve a specific flow template by its ID | +| `webex cc templates list-flow` | `GET /templates` | List available flow templates that can be used to create new flows. | +| `webex cc usage-reports create` | `POST /v1/usage-reports` | Creates a new usage report for the specified organization, resource type, | +| `webex cc usage-reports delete` | `DELETE /v1/usage-reports/{reportId}` | Deletes the specified usage report and its associated file | +| `webex cc usage-reports download-file` | `GET /v1/usage-reports/{fileId}/download` | Downloads one completed report file as a binary stream. | +| `webex cc usage-reports get` | `GET /v1/usage-reports/{reportId}` | Retrieves detailed information for a specific usage report. | +| `webex cc usage-reports list` | `GET /v1/usage-reports` | Retrieves a list of usage reports for the organization | +| `webex cc usage-reports list-resource-types` | `GET /v1/usage-reports/resource-types` | Returns the list of available resource types that can be used for report generation, along with available data dates. | +| `webex cc users bulk-partial-update-dynamic-skills` | `PATCH /organization/{orgid}/user/bulk/update-dynamic-skill/{skillId}` | Assign or unassign a dynamic skill to/from multiple users in bulk for a given organization. | +| `webex cc users list-by-ids` | `POST /organization/{orgid}/user/fetch-user-details-by-ids` | Retrieve an existing User's first name, last name and email by list of IDs in a given organization. | +| `webex cc users list-call-monitoring-id` | `GET /organization/{orgid}/user/by-call-monitoring-id/{id}` | Fetch paginated users associated to the selected call monitoring team filters while enforcing team ACL. | + +### Existing names with changed routes + +| Full command | Previous route | Current route | +| --- | --- | --- | +| `webex cc contact-list-management get-within-campaign` | `GET /v3/campaign-management/campaigns/{campaignId}/contact-lists` | `GET /v4/campaign-management/campaigns/{campaignId}/contact-lists` | +| `webex cc flow export` | `GET /flow-store/{orgId}/project/{projectId}/flows/{flowId}:export` | `GET /{orgId}/project/{projectId}/v2/flows/{flowId}:export` | +| `webex cc flow import` | `POST /flow-store/{orgId}/project/{projectId}/flows:import` | `POST /{orgId}/project/{projectId}/v2/flows:import` | +| `webex cc flow list` | `GET /flow-store/{orgId}/project/{projectId}/flows` | `GET /{orgId}/project/{projectId}/flows` | +| `webex cc flow publish` | `POST /flow-store/{orgId}/project/{projectId}/flows/{flowId}:publish` | `POST /{orgId}/project/{projectId}/flows/{flowId}:publish` | + +### Previous canonical names + +| Previous command | Status | +| --- | --- | +| `webex cc agent-personal-greeting-files create-v2-api` | Alias for `webex cc agent-personal-greeting-files create` | +| `webex cc agent-personal-greeting-files delete-id-v2-api` | Alias for `webex cc agent-personal-greeting-files delete-id` | +| `webex cc agent-personal-greeting-files delete-references-1` | Alias for `webex cc agent-personal-greeting-files delete-references` | +| `webex cc agent-personal-greeting-files get-id-v2-api` | Alias for `webex cc agent-personal-greeting-files get-id` | +| `webex cc agent-personal-greeting-files patch-id-v2-api` | Alias for `webex cc agent-personal-greeting-files patch-id` | +| `webex cc agent-personal-greeting-files update-id-v2-api` | Alias for `webex cc agent-personal-greeting-files update-id` | +| `webex cc contact-service-queue delete-csq-references` | Alias for `webex cc contact-service-queue delete-references` | +| `webex cc contact-service-queue list-csq-references-id` | Alias for `webex cc contact-service-queue list-references` | +| `webex cc contact-service-queue list-csqs-skills-profile` | Alias for `webex cc contact-service-queue list-by-dynamic-skills` | +| `webex cc contact-service-queue list-csqs-user-profile` | Alias for `webex cc contact-service-queue list-by-user-skill-profile` | +| `webex cc contact-service-queue list-manually-assignable-csqs` | Alias for `webex cc contact-service-queue list-manually-assignable` | +| `webex cc contact-service-queue list-skill-csqs-skill-profile` | Alias for `webex cc contact-service-queue list-by-skill-profile` | +| `webex cc outdial-ani bulk-save-entry` | Alias for `webex cc outdial-ani bulk-save-entries` | +| `webex cc outdial-ani list-entry` | Alias for `webex cc outdial-ani list-entries` | +| `webex cc outdial-ani list-entry-2` | Alias for `webex cc outdial-ani list-entries-for-ani` | +| `webex cc tasks resume` | Alias for `webex cc tasks unhold` | +| `webex cc tasks update-2` | Alias for `webex cc tasks append-message` | +| `webex cc users bulk-update-dynamic-skills` | Alias for `webex cc users bulk-partial-update-dynamic-skills` | +| `webex cc users get-ids` | Alias for `webex cc users list-by-ids` | + +## meetings + +### Added canonical names + +| Full command | Method and path | Purpose | +| --- | --- | --- | +| `webex meetings meetings list-group` | `GET /group/meetings` | List group meetings with a specified meeting number or web link by a service app which has group meeting access | +| `webex meetings meetings patch-group` | `PATCH /group/meetings/{meetingId}` | Patches details for a group meeting with a specified meeting ID by a service app which has group meeting access | +| `webex meetings meetings update-group-control-status` | `POST /group/meetings/controls` | Update meeting recording control status by a service app which has group meeting access | +| `webex meetings recordings query` | `POST /recordings/query` | Queries recordings with filters in the request body | +| `webex meetings recordings query-admin-compliance-officer` | `POST /admin/recordings/query` | Queries recordings for an admin or compliance officer with filters in the request body | + +## messaging + +### Added canonical names + +| Full command | Method and path | Purpose | +| --- | --- | --- | +| `webex messaging hds get-alarms-node` | `GET /hds/nodes/{nodeId}/alarms` | Returns the alarm details for a single HDS node for the provided time range (last 24 hours). | +| `webex messaging hds get-database-config-org` | `GET /hds/organizations/{organizationId}/database` | Retrieve details of database information for an HDS organization, such as database type and version used. | +| `webex messaging hds get-usage-node` | `GET /hds/nodes/{nodeId}/resourceUsage` | Retrieve CPU, memory, and disk resource usage details for a specific HDS node over the requested time range. | +| `webex messaging hds list-clusters-org` | `GET /hds/organizations/{organizationId}/clusters` | Retrieve a list of all clusters for a specific HDS organization, including cluster status, release channel, and upgrade schedule details. | +| `webex messaging hds list-nodes-cluster` | `GET /hds/clusters/{clusterId}/nodes` | Retrieve a list of all nodes for a specific HDS cluster, including availability, proxy details, deployment type, and release version. | +| `webex messaging hds list-tenants-org` | `GET /hds/organizations/{organizationId}/tenants` | Retrieve details of Multi-Tenant HDS organization such as Organization Name and ID, CMK state and state of Tenants Organizations. | + +### Previous canonical names + +| Previous command | Status | +| --- | --- | +| `webex messaging hds get-database-org-2` | Alias for `webex messaging hds get-database-config-org` | +| `webex messaging hds get-multi-tenant-org-2` | Alias for `webex messaging hds list-tenants-org` | + +## Limitations + +`cc functions import` lacks multipart upload handling. `cc flow import-legacy` lacks legacy upload body handling. Current-format flow import was live-tested; publish was not. Usage report types and completed-task variable updates were not tenant-tested. diff --git a/codegen/NAMING.md b/codegen/NAMING.md new file mode 100644 index 0000000..ef1065a --- /dev/null +++ b/codegen/NAMING.md @@ -0,0 +1,215 @@ +# Renamed CLI commands in the Postman refresh + +Every row gives the full previous command, its current canonical command, what the operation does, and whether the previous spelling still invokes that same operation. Append `--help` to any current command to see its arguments and flags. + +**Previous-name source:** “PR #10” means the automatic refresh before our naming overrides. “Before refresh” means an older spelling retained for compatibility. These are different baselines: in particular, `webex cc tasks resume` meant unhold before the refresh, but the unmodified PR assigned it to digital-task resume. + +**Flow formats:** `flow import`/`export` use the current typed flow document; `import-legacy`/`export-legacy` use deprecated raw FDL. This intentionally changes the format of the pre-refresh unsuffixed commands. Current flow, activity, event, and template commands use unprefixed URLs. Duplicate prefixed commands and the temporary `-direct` names have been removed. + +This reference contains **94 previous-to-current mappings**. Commands whose names and groups did not change are omitted. + +## calling call-controls-for-me + +| Previous full command | Source | Current full command | What it does | Previous spelling still works? | +| --- | --- | --- | --- | --- | +| `webex calling call-controls dial-2` | PR #10 | `webex calling call-controls-for-me dial` | Initiate an outbound call to a specified destination. | No — use the new command | +| `webex calling call-controls answer-2` | PR #10 | `webex calling call-controls-for-me answer` | Answer an incoming call. | No — use the new command | +| `webex calling call-controls hangup-2` | PR #10 | `webex calling call-controls-for-me hangup` | Hangup a call. | No — use the new command | +| `webex calling call-controls list-2` | PR #10 | `webex calling call-controls-for-me list` | Get the list of details for all active calls associated with the user. | No — use the new command | +| `webex calling call-controls get-3` | PR #10 | `webex calling call-controls-for-me get` | Get the details of the specified active call for the user. | No — use the new command | + +## calling metrics + +| Previous full command | Source | Current full command | What it does | Previous spelling still works? | +| --- | --- | --- | --- | --- | +| `webex admin calling-metrics webex-call-quality-stats` | PR #10 | `webex calling metrics get-call-quality-stats` | Retrieve aggregated Calling call and media-quality statistics for the authenticated organization. Requires Pro Pack; query up to seven days within the previous three weeks. | No — use the new command | + +## cc activities + +| Previous full command | Source | Current full command | What it does | Previous spelling still works? | +| --- | --- | --- | --- | --- | +| `webex cc activities list-definitions-2` | PR #10 | `webex cc activities list-definitions` | List all available activity types with their full schemas, including inputs, outputs, ports, and descriptions. | No — use the new command | +| `webex cc activities describe-2` | PR #10 | `webex cc activities describe` | Retrieve a single activity's full definition, including inputs, outputs, named ports, and the JSON Schema for its inputs — all returned inline. | No — use the new command | +| `webex cc activities get-input-choices-2` | PR #10 | `webex cc activities get-input-choices` | Resolve valid values for an activity input, such as queues, audio files, or agents; supports search, validation, and cascading parent inputs. | No — use the new command | + +## cc agent-personal-greeting-files + +| Previous full command | Source | Current full command | What it does | Previous spelling still works? | +| --- | --- | --- | --- | --- | +| `webex cc agent-personal-greeting-files create-v2-api` | Before refresh | `webex cc agent-personal-greeting-files create` | Create a new Greeting File in a given organization. | Yes — alias | +| `webex cc agent-personal-greeting-files delete-references-1` | Before refresh | `webex cc agent-personal-greeting-files delete-references` | Removes all references of the specified agent (ciUserId) from greeting files in the given organization. | Yes — alias | +| `webex cc agent-personal-greeting-files get-id-v2-api` | Before refresh | `webex cc agent-personal-greeting-files get-id` | Retrieve an existing Greeting File by ID in a given organization. | Yes — alias | +| `webex cc agent-personal-greeting-files update-id-v2-api` | Before refresh | `webex cc agent-personal-greeting-files update-id` | Update an existing Greeting File by ID in a given organization. | Yes — alias | +| `webex cc agent-personal-greeting-files delete-id-v2-api` | Before refresh | `webex cc agent-personal-greeting-files delete-id` | Delete an existing Greeting File by ID in a given organization. | Yes — alias | +| `webex cc agent-personal-greeting-files patch-id-v2-api` | Before refresh | `webex cc agent-personal-greeting-files patch-id` | Partially update Greeting File by ID in a given organization. | Yes — alias | + +## cc contact-service-queue + +| Previous full command | Source | Current full command | What it does | Previous spelling still works? | +| --- | --- | --- | --- | --- | +| `webex cc contact-service-queue list-skill-based-skill-profile-id` | PR #10 | `webex cc contact-service-queue list-by-skill-profile` | Retrieve a list of skill-based Contact Service Queues associated with a given skill profile ID, accessible to authorized clients in a given organization. | No — use the new command | +| `webex cc contact-service-queue list-skill-csqs-skill-profile` | Before refresh | `webex cc contact-service-queue list-by-skill-profile` | Retrieve a list of skill-based Contact Service Queues associated with a given skill profile ID, accessible to authorized clients in a given organization. | Yes — alias | +| `webex cc contact-service-queue delete-csq-references` | Before refresh | `webex cc contact-service-queue delete-references` | Removes the references to the specified entities (such as teams, sites, or agents) from Contact Service Queues for a given organization. | Yes — alias | +| `webex cc contact-service-queue list-manually-assignable-csqs` | Before refresh | `webex cc contact-service-queue list-manually-assignable` | Retrieve a list of Contact Service Queues that are eligible for manual contact assignment based on the provided criteria in a given organization. | Yes — alias | +| `webex cc contact-service-queue list-csq-references-id` | Before refresh | `webex cc contact-service-queue list-references` | Retrieve a list of all entities that have reference to an existing Contact Service Queue by ID in a given organization. | Yes — alias | +| `webex cc contact-service-queue list-agent-based-user-id` | PR #10 | `webex cc contact-service-queue list-agent-based` | Retrieve a list of agent-based Contact Service Queues by user ID in a given organization. | No — use the new command | +| `webex cc contact-service-queue list-skill-based-user-id` | PR #10 | `webex cc contact-service-queue list-skill-based` | Retrieve a list of skill-based Contact Service Queues by user ID in a given organization. | No — use the new command | +| `webex cc contact-service-queue list-team-based-user-id` | PR #10 | `webex cc contact-service-queue list-team-based` | Retrieve a list of team-based Contact Service Queues by user ID in a given organization. | No — use the new command | +| `webex cc contact-service-queue list-skill-based-dynamic-skills-skill-profile` | PR #10 | `webex cc contact-service-queue list-by-dynamic-skills` | Retrieve a list of skill-based Contact Service Queues that match the given dynamic skills and skill profile criteria in a given organization. | No — use the new command | +| `webex cc contact-service-queue list-csqs-skills-profile` | Before refresh | `webex cc contact-service-queue list-by-dynamic-skills` | Retrieve a list of skill-based Contact Service Queues that match the given dynamic skills and skill profile criteria in a given organization. | Yes — alias | +| `webex cc contact-service-queue list-skill-based-skill-profile-id-user-id` | PR #10 | `webex cc contact-service-queue list-by-user-skill-profile` | Retrieve a list of skill-based Contact Service Queues associated with the given skill profile ID and user ID combination in a given organization. | No — use the new command | +| `webex cc contact-service-queue list-csqs-user-profile` | Before refresh | `webex cc contact-service-queue list-by-user-skill-profile` | Retrieve a list of skill-based Contact Service Queues associated with the given skill profile ID and user ID combination in a given organization. | Yes — alias | + +## cc events + +| Previous full command | Source | Current full command | What it does | Previous spelling still works? | +| --- | --- | --- | --- | --- | +| `webex cc events list-specifications-2` | PR #10 | `webex cc events list-specifications` | List the event types available for use in `event_flows[]`. | No — use the new command | + +## cc flow + +| Previous full command | Source | Current full command | What it does | Previous spelling still works? | +| --- | --- | --- | --- | --- | +| `webex cc flow export` | PR #10 | `webex cc flow export-legacy` | Export a flow or subflow in legacy raw FDL format. This API is deprecated; the existing command keeps its original route. | **No — now resolves to a different operation; use the new command.** | +| `webex cc flow import` | PR #10 | `webex cc flow import-legacy` | Import a flow or subflow in legacy raw FDL format. This API is deprecated; the existing command keeps its original route. | **No — now resolves to a different operation; use the new command.** | +| `webex cc flows list` | PR #10 | `webex cc flow list` | List flows or subflows, with name, ID, channel, and pagination filters. | Yes — alias | +| `webex cc flows publish` | PR #10 | `webex cc flow publish` | Publish a flow or subflow. | Yes — alias | +| `webex cc flows lock` | PR #10 | `webex cc flow lock` | Lock a flow or subflow against concurrent edits. Locks expire after 15 minutes of inactivity. | Yes — alias | +| `webex cc flows unlock` | PR #10 | `webex cc flow unlock` | Release a flow or subflow edit lock. | Yes — alias | +| `webex cc flows validate` | PR #10 | `webex cc flow validate` | Validate a supplied flow definition without saving it. Passing validation does not guarantee import will succeed. | Yes — alias | +| `webex cc flows import` | PR #10 | `webex cc flow import` | Import a v2 flow definition as a new draft and return the assigned flow metadata. | Yes — alias | +| `webex cc flows get` | PR #10 | `webex cc flow get` | Retrieve the current flow draft. Use export to retrieve a published version. | Yes — alias | +| `webex cc flows save-draft` | PR #10 | `webex cc flow save-draft` | Replace the complete flow draft. Optional expectedVersion prevents overwriting a concurrently changed draft. | Yes — alias | +| `webex cc flows patch-draft` | PR #10 | `webex cc flow patch-draft` | Apply a partial update to a flow draft; validate the merged result before saving it. | Yes — alias | +| `webex cc flows validate-draft` | PR #10 | `webex cc flow validate-draft` | Validate the stored flow draft without changing it. | Yes — alias | +| `webex cc flows export` | PR #10 | `webex cc flow export` | Export a v2 flow document for backup, migration, or version control. | Yes — alias | +| `webex cc flows list-2` | PR #10 | `webex cc flow list` | List flows or subflows, with name, ID, channel, and pagination filters. | No — use the new command | +| `webex cc flows publish-2` | PR #10 | `webex cc flow publish` | Publish a flow or subflow. | No — use the new command | +| `webex cc flows lock-2` | PR #10 | `webex cc flow lock` | Lock a flow or subflow against concurrent edits. Locks expire after 15 minutes of inactivity. | No — use the new command | +| `webex cc flows unlock-2` | PR #10 | `webex cc flow unlock` | Release a flow or subflow edit lock. | No — use the new command | +| `webex cc flows validate-2` | PR #10 | `webex cc flow validate` | Validate a supplied flow definition without saving it. Passing validation does not guarantee import will succeed. | No — use the new command | +| `webex cc flows import-2` | PR #10 | `webex cc flow import` | Import a v2 flow definition as a new draft and return the assigned flow metadata. | No — use the new command | +| `webex cc flows get-2` | PR #10 | `webex cc flow get` | Retrieve the current flow draft. Use export to retrieve a published version. | No — use the new command | +| `webex cc flows save-draft-2` | PR #10 | `webex cc flow save-draft` | Replace the complete flow draft. Optional expectedVersion prevents overwriting a concurrently changed draft. | No — use the new command | +| `webex cc flows patch-draft-2` | PR #10 | `webex cc flow patch-draft` | Apply a partial update to a flow draft; validate the merged result before saving it. | No — use the new command | +| `webex cc flows validate-draft-2` | PR #10 | `webex cc flow validate-draft` | Validate the stored flow draft without changing it. | No — use the new command | +| `webex cc flows export-2` | PR #10 | `webex cc flow export` | Export a v2 flow document for backup, migration, or version control. | No — use the new command | +| `webex cc flows search` | PR #10 | `webex cc flow search` | Search flows or subflows using a case-sensitive query. | No — use the new command | +| `webex cc flows delete` | PR #10 | `webex cc flow delete` | Permanently delete a flow or subflow; deletion cannot be undone. | No — use the new command | +| `webex cc legacy-flows export` | PR #10 | `webex cc flow export-legacy` | Export a flow or subflow in legacy raw FDL format. This API is deprecated; the existing command keeps its original route. | No — use the new command | +| `webex cc legacy-flows import` | PR #10 | `webex cc flow import-legacy` | Import a flow or subflow in legacy raw FDL format. This API is deprecated; the existing command keeps its original route. | No — use the new command | + +## cc functions + +| Previous full command | Source | Current full command | What it does | Previous spelling still works? | +| --- | --- | --- | --- | --- | +| `webex cc functions list-custom` | PR #10 | `webex cc functions list` | List or search custom functions in the organization. | No — use the new command | +| `webex cc functions create-custom` | PR #10 | `webex cc functions create` | Create a new custom function. | No — use the new command | +| `webex cc functions get-custom` | PR #10 | `webex cc functions get` | Retrieve a function draft, or a specific published version/tag. | No — use the new command | +| `webex cc functions update-custom` | PR #10 | `webex cc functions update` | Update an existing custom function by ID. | No — use the new command | +| `webex cc functions delete-custom` | PR #10 | `webex cc functions delete` | Delete a custom function by ID. | No — use the new command | +| `webex cc functions import-custom` | PR #10 | `webex cc functions import` | Import a function-definition JSON file as a multipart upload. The current generated CLI command still lacks file-upload handling; naming it does not fix that limitation. | No — use the new command | +| `webex cc functions unlock-custom` | PR #10 | `webex cc functions unlock` | Release the edit lock on a custom function so that other users can edit it. | No — use the new command | +| `webex cc functions lock-custom` | PR #10 | `webex cc functions lock` | Acquire an edit lock on a custom function to prevent concurrent writes by other users. | No — use the new command | +| `webex cc functions test-custom` | PR #10 | `webex cc functions test` | Execute a function with a test payload. The API implicitly publishes the latest draft before running it. | No — use the new command | +| `webex cc functions publish-custom` | PR #10 | `webex cc functions publish` | Publish the latest function draft under one or more tags: Dev, Test, Latest, or Live. | No — use the new command | +| `webex cc functions export-custom` | PR #10 | `webex cc functions export` | Export a selected function version or publish tag as function-definition JSON, including source code, inputs, and outputs. | No — use the new command | + +## cc outdial-ani + +| Previous full command | Source | Current full command | What it does | Previous spelling still works? | +| --- | --- | --- | --- | --- | +| `webex cc outdial-ani list-entry` | Before refresh | `webex cc outdial-ani list-entries` | Retrieve a list of Outdial ANI Entries in a given organization. | Yes — alias | +| `webex cc outdial-ani bulk-save-entry` | Before refresh | `webex cc outdial-ani bulk-save-entries` | Create, Update or delete Outdial ANI Entries in bulk for an Address Book in a given organization. | Yes — alias | +| `webex cc outdial-ani list-entries-2` | PR #10 | `webex cc outdial-ani list-entries-for-ani` | List outbound caller-ID (ANI) entries belonging to a specified outdial ANI ID. | No — use the new command | +| `webex cc outdial-ani list-entry-2` | Before refresh | `webex cc outdial-ani list-entries-for-ani` | List outbound caller-ID (ANI) entries belonging to a specified outdial ANI ID. | Yes — alias | + +## cc tasks + +| Previous full command | Source | Current full command | What it does | Previous spelling still works? | +| --- | --- | --- | --- | --- | +| `webex cc tasks resume` | Before refresh | `webex cc tasks unhold` | Resume a voice call that is on hold. This preserves the released meaning of `tasks resume`. | Yes — alias | +| `webex cc tasks update-2` | Before refresh | `webex cc tasks append-message` | Append a message to an existing task using the v2 messages endpoint (beta). | Yes — alias | +| `webex cc tasks pause` | PR #10 | `webex cc tasks pause-digital` | Pause a non-real-time digital task that cannot be handled immediately. | No — use the new command | +| `webex cc tasks resume` | PR #10 | `webex cc tasks resume-digital` | Resume a paused non-real-time digital task, such as email or social messaging. | **No — now resolves to a different operation; use the new command.** | + +## cc templates + +| Previous full command | Source | Current full command | What it does | Previous spelling still works? | +| --- | --- | --- | --- | --- | +| `webex cc templates list-flow-2` | PR #10 | `webex cc templates list-flow` | List available flow templates that can be used to create new flows. | No — use the new command | +| `webex cc templates get-flow-2` | PR #10 | `webex cc templates get-flow` | Retrieve a specific flow template by its ID. | No — use the new command | + +## cc usage-reports + +| Previous full command | Source | Current full command | What it does | Previous spelling still works? | +| --- | --- | --- | --- | --- | +| `webex cc usage-reports get-available-types` | PR #10 | `webex cc usage-reports list-resource-types` | Returns the list of available resource types that can be used for report generation, along with available data dates. | No — use the new command | + +## cc users + +| Previous full command | Source | Current full command | What it does | Previous spelling still works? | +| --- | --- | --- | --- | --- | +| `webex cc users list-2` | PR #10 | `webex cc users list-by-ids` | Retrieve an existing User's first name, last name and email by list of IDs in a given organization. | No — use the new command | +| `webex cc users get-ids` | Before refresh | `webex cc users list-by-ids` | Retrieve an existing User's first name, last name and email by list of IDs in a given organization. | Yes — alias | +| `webex cc users bulk-update-dynamic-skills` | Before refresh | `webex cc users bulk-partial-update-dynamic-skills` | Assign or unassign a dynamic skill to/from multiple users in bulk for a given organization. | Yes — alias | + +## messaging hds + +| Previous full command | Source | Current full command | What it does | Previous spelling still works? | +| --- | --- | --- | --- | --- | +| `webex messaging hds get-database-org-2` | PR #10 | `webex messaging hds get-database-config-org` | Retrieve details of database information for an HDS organization, such as database type and version used. | Yes — alias | +| `webex messaging hds get-multi-tenant-org-2` | PR #10 | `webex messaging hds list-tenants-org` | Retrieve tenant organization names/IDs, tenant states, and customer-managed-key state for a multi-tenant HDS organization. | Yes — alias | +| `webex messaging hybrid-data-security get-org` | PR #10 | `webex messaging hds get-org` | Retrieve details for an Hybrid Data Security organization, such as the organization name, type of organization. | Yes — alias | +| `webex messaging hybrid-data-security list-clusters-org` | PR #10 | `webex messaging hds list-clusters-org` | Retrieve a list of all clusters for a specific Hybrid Data Security organization, including cluster status, release channel, and upgrade schedule details. | Yes — alias | +| `webex messaging hybrid-data-security get-cluster` | PR #10 | `webex messaging hds get-cluster` | Retrieve details for a specific Hybrid Data Security cluster, such as the cluster name, cluster status, upgrade schedule, and Hybrid Data Security nodes in the cluster. | Yes — alias | +| `webex messaging hybrid-data-security list-nodes-cluster` | PR #10 | `webex messaging hds list-nodes-cluster` | Retrieve a list of all nodes for a specific Hybrid Data Security cluster, including availability, proxy details, deployment type, and release version. | Yes — alias | +| `webex messaging hybrid-data-security get-node` | PR #10 | `webex messaging hds get-node` | Retrieve details for a specific Hybrid Data Security node, such as host name, release version, proxy details, deployment and build type, availability details, etc. | Yes — alias | +| `webex messaging hybrid-data-security get-database-org` | PR #10 | `webex messaging hds get-database-config-org` | Retrieve details of database information for an Hybrid Data Security organization, such as database type and version used. | **No — now resolves to a different operation; use the new command.** | +| `webex messaging hybrid-data-security get-multi-tenant-org` | PR #10 | `webex messaging hds list-tenants-org` | Retrieve tenant organization names/IDs, tenant states, and customer-managed-key state for a multi-tenant HDS organization. | **No — now resolves to a different operation; use the new command.** | +| `webex messaging hybrid-data-security get-alarms-node` | PR #10 | `webex messaging hds get-alarms-node` | Returns the alarm details for a single Hybrid Data Security node for the provided time range (last 24 hours). | Yes — alias | +| `webex messaging hybrid-data-security get-test-results-node` | PR #10 | `webex messaging hds get-test-results-node` | Retrieve the latest node network-test results, including bandwidth, DNS resolution, and HTTPS connectivity. | Yes — alias | +| `webex messaging hybrid-data-security get-usage-node` | PR #10 | `webex messaging hds get-usage-node` | Retrieve CPU, memory, and disk resource usage details for a specific Hybrid Data Security node over the requested time range. | Yes — alias | +| `webex messaging hybrid-data-security get-availability-cluster` | PR #10 | `webex messaging hds get-availability-cluster` | Get the availability details for an Hybrid Data Security cluster, where each segment specifies the start and end times, as well as the number of online, offline, and total nodes within that segment. | Yes — alias | + +## Cloverhound read-only route checks — 2026-09-29 + +Tested with the Cloverhound organization on `https://api.wxcc-us1.cisco.com` using authenticated GET requests only. No import, publish, lock, save, patch, or delete requests were executed. + +| Operation | With `/flow-store/` | Without `/flow-store/` | Comparison | +| --- | --- | --- | --- | +| List flows | 200 | 200 | Identical parsed JSON | +| Get one flow draft | 200 | 200 | Identical parsed JSON | +| Export that flow using the current format | 200 | 200 | Identical parsed JSON | +| List activity definitions | 200 | 200 | Identical parsed JSON | +| List event specifications | 200 | 200 | Identical parsed JSON | +| List templates | 404 at the org/project-scoped v2 template route | 200 at `/templates` | Different routing behavior | + +Legacy flow export also returned 200 and an FDL document. For this organization and the tested reads, both flow URL forms work on the same production host. This does not establish equivalence for all operations or tenants. The subsequent draft write checks below support consolidating current operations onto unprefixed routes. `webex cc templates list-flow` now uses `/templates`. Activity input choices retain the unprefixed request’s search/validate/parent-input parameters. + +## Cloverhound disposable-flow write checks — 2026-09-29 (Denver) + +Created draft `CLI_Route_Test_ce61ca68ca8b` (ID `6abc548b79b443250d35110c`) using the unprefixed import URL with `overwrite=false`. The flow contained only a start activity and a disconnect activity. It was never published or assigned to an entry point/routing strategy. + +| Check | Result | +| --- | --- | +| Validate through unprefixed route | Valid; only a recommendation to add activity descriptions | +| Import through unprefixed route | 201; new unassigned draft | +| Read new draft through `/flow-store/` route | 200; correct new flow | +| Lock prefixed, unlock unprefixed | Both 200 | +| Lock unprefixed, unlock prefixed | Both 200 | +| Patch description prefixed, read unprefixed | Both 200; updated description verified | +| Patch description unprefixed, read prefixed | Both 200; updated description verified | +| Save complete draft prefixed, read unprefixed | Both 200; saved description verified | +| Save complete draft unprefixed, read prefixed | Both 200; saved description verified | +| Export draft through both routes | Both 200; correct test flow | +| Delete through unprefixed route, without force or skipped reference checks | 200 | +| Read deleted flow through both routes | Both 404; cleanup confirmed | + +These checks establish that both URL forms act on the same flow and support the tested draft lifecycle in Cloverhound. The unprefixed URLs are sufficient for those current-format operations; separate prefixed command variants provide no demonstrated additional capability. Publish and legacy import/export were not exercised in this write test. Keep legacy-format commands distinct from current-format commands regardless of URL-prefix consolidation. + +## Maintaining this reference + +Duplicate prefixed entries are excluded through `SUPERSEDED_ROUTES` in `codegen/naming_overrides.py`. Each exclusion identifies a required replacement request; extraction fails if it disappears. The generator keeps the replacement’s complete request contract. Legacy import/export retain their prefixed routes. Publish uses the unprefixed route but was not live-tested. + +Names and compatibility aliases are defined in `codegen/naming_overrides.py` and applied to the enriched spec before generating Go commands and skill references. Update the override table, run `make codegen`, and update this reference when changing a mapping. Handwritten request implementations continue to use `custom_*.go` and the generator skip lists. diff --git a/codegen/extract_api_spec.py b/codegen/extract_api_spec.py index 7407f67..8d1f8fc 100644 --- a/codegen/extract_api_spec.py +++ b/codegen/extract_api_spec.py @@ -13,6 +13,7 @@ import glob import os import re +from naming_overrides import NAMING_OVERRIDES, GROUP_ALIASES, COLLECTION_MOVES, SUPERSEDED_ROUTES SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__)) @@ -364,6 +365,56 @@ def merge_folders(folders): return [merged[g] for g in order] +def apply_naming_overrides(collection_name, folders): + """Resolve explicit naming exceptions and identical routes across merged groups.""" + overrides = NAMING_OVERRIDES.get(collection_name, {}) + superseded = SUPERSEDED_ROUTES.get(collection_name, {}) + available = {(e['method'], e['path']) for f in folders for e in f['endpoints']} + merged = {} + for folder in folders: + source_group = folder['group'] + for endpoint in folder['endpoints']: + ep = dict(endpoint) + key = (source_group, ep['method'], ep['path']) + if key in superseded: + if superseded[key] not in available: + raise ValueError(f"Missing replacement for {collection_name} {key}") + continue + group, command, aliases = overrides.get( + key, (source_group, ep['command'], ())) + ep['command'] = command + ep['aliases'] = list(aliases) + target = merged.setdefault(group, { + 'group': group, 'original_folders': [], 'endpoints': [], + 'aliases': GROUP_ALIASES.get(collection_name, {}).get(group, []), + }) + for original in folder['original_folders']: + if original not in target['original_folders']: + target['original_folders'].append(original) + # Only collapse identical routes when deliberately merging groups. + # Other collections may document distinct request contracts at one URL. + if group in GROUP_ALIASES.get(collection_name, {}): + existing = next((e for e in target['endpoints'] + if (e['method'], e['path']) == (ep['method'], ep['path'])), None) + if existing is not None: + for alias in [command, *aliases]: + if alias != existing['command'] and alias not in existing['aliases']: + existing['aliases'].append(alias) + continue + target['endpoints'].append(ep) + changed_groups = {value[0] for value in overrides.values()} + for group in merged.values(): + if group['group'] not in changed_groups: + continue + names = set() + for ep in group['endpoints']: + for name in [ep['command'], *ep['aliases']]: + if name in names: + raise ValueError(f"Duplicate command or alias: {collection_name} {group['group']} {name}") + names.add(name) + return list(merged.values()) + + def main(): pattern = os.path.join(SCRIPT_DIR, "postman", "*.postman_collection.json") files = sorted(glob.glob(pattern)) @@ -376,12 +427,20 @@ def main(): for filepath in files: name, raw_folders = extract_collection(filepath) folders = merge_folders(raw_folders) + folders = apply_naming_overrides(name, folders) result[name] = folders total_groups = len(folders) total_eps = sum(len(f['endpoints']) for f in folders) print(f"{name}: {total_groups} groups, {total_eps} endpoints") + for (source, group), destination in COLLECTION_MOVES.items(): + moved = [g for g in result[source] if g['group'] == group] + if any(g['group'] == group for g in result[destination]): + raise ValueError(f"Destination group already exists: {destination} {group}") + result[source] = [g for g in result[source] if g['group'] != group] + result[destination].extend(moved) + output_path = os.path.join(SCRIPT_DIR, "api_spec.json") with open(output_path, "w") as f: json.dump(result, f, indent=2) diff --git a/codegen/generate_cli.py b/codegen/generate_cli.py index d4b30e6..a3bf623 100644 --- a/codegen/generate_cli.py +++ b/codegen/generate_cli.py @@ -10,6 +10,7 @@ import re import subprocess import textwrap +from naming_overrides import GROUP_ALIASES SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__)) CLI_DIR = os.path.dirname(SCRIPT_DIR) # repo root (parent of codegen/) @@ -32,6 +33,7 @@ # Collection name → URL path prefix → Go expression for the base URL. BASE_URL_OVERRIDES = { "Webex Cloud Calling": { + "/v1/analytics/": "config.AnalyticsBaseURL", # Detailed Call History (CDR) — region-specific analytics FQDN. "/cdr_feed": "config.AnalyticsCallingBaseURL()", "/cdr_stream": "config.AnalyticsCallingBaseURL()", @@ -212,6 +214,9 @@ def generate_group_file(group, endpoints, pkg, parent_var, base_url_const, is_ca lines.append(f'var {group_var} = &cobra.Command{{') lines.append(f'\tUse: "{group}",') + aliases = GROUP_ALIASES.get(collection_name, {}).get(group, []) + if aliases: + lines.append('\tAliases: []string{' + ', '.join(escape_go_double_quoted(a) for a in aliases) + '},') lines.append(f'\tShort: "{group_pascal} commands",') lines.append(f'}}') lines.append('') @@ -349,6 +354,8 @@ def generate_command(ep, group_var, base_url_expr, is_calling): lines.append(f'{indent2}cmd := &cobra.Command{{') lines.append(f'{indent2}\tUse: {escape_go_double_quoted(cmd_name)},') + if ep.get('aliases'): + lines.append(f'{indent2}\tAliases: []string{{' + ', '.join(escape_go_double_quoted(a) for a in ep['aliases']) + '},') lines.append(f'{indent2}\tShort: {escape_go_double_quoted(original_name)},') if description: diff --git a/codegen/generate_skills.py b/codegen/generate_skills.py index 832b7c5..6f1cd8b 100644 --- a/codegen/generate_skills.py +++ b/codegen/generate_skills.py @@ -82,6 +82,8 @@ def format_flags(ep): seen = set() for p in ep.get('path_params', []): + if p['name'] in ('projectId', 'orgId', 'orgid'): + continue # Project is fixed; organization uses the global override. flag = camel_to_kebab(p['name']) if flag not in seen: seen.add(flag) @@ -119,7 +121,10 @@ def generate_command_reference(area_cmd, groups, collection_name): "## Command Reference", "", "> Auto-generated from Postman collections. Run `make codegen` to update.", + "> Organization defaults to the authenticated account; use `--organization` to override.", ] + if area_cmd == 'cc': + lines.append('> The flow project ID is fixed internally; no project flag is needed.') for group_data in groups: group = group_data['group'] @@ -139,11 +144,18 @@ def generate_command_reference(area_cmd, groups, collection_name): "", f"### {group}", "", + ] + if group_data.get('aliases'): + lines += ['Group aliases: ' + ', '.join(f'`{a}`' for a in group_data['aliases']) + '.', ''] + lines += [ "| Command | Flags |", "|---|---|", ] for ep in visible: - lines.append(f"| `{ep['command']}` | {format_flags(ep)} |") + name = f"`{ep['command']}`" + if ep.get('aliases'): + name += ' (aliases: ' + ', '.join(f'`{a}`' for a in ep['aliases']) + ')' + lines.append(f"| {name} | {format_flags(ep)} |") return "\n".join(lines) + "\n" diff --git a/codegen/naming_overrides.py b/codegen/naming_overrides.py new file mode 100644 index 0000000..fa04106 --- /dev/null +++ b/codegen/naming_overrides.py @@ -0,0 +1,292 @@ +"""Stable CLI names for ambiguous or renamed Postman requests. + +Like BASE_URL_OVERRIDES, these exceptions use HTTP routes, not collection order. +Current flow APIs use the unprefixed service routes verified in Cloverhound. +Legacy FDL import/export keep their original /flow-store/ routes. +Do not add aliases for unreleased numeric collision names. +""" + +# collection -> (source group, method, path) -> (group, command, aliases) +NAMING_OVERRIDES = { + 'Webex Admin': { + ('calling-metrics', 'GET', '/v1/analytics/callQualityStats'): + ('metrics', 'get-call-quality-stats', ()), + }, + 'Webex Cloud Calling': { + ('call-controls', 'POST', '/telephony/calls/members/me/dial'): + ('call-controls-for-me', 'dial', ()), + ('call-controls', 'POST', '/telephony/calls/members/me/answer'): + ('call-controls-for-me', 'answer', ()), + ('call-controls', 'POST', '/telephony/calls/members/me/hangup'): + ('call-controls-for-me', 'hangup', ()), + ('call-controls', 'GET', '/telephony/calls/members/me/calls'): + ('call-controls-for-me', 'list', ()), + ('call-controls', 'GET', '/telephony/calls/members/me/calls/{callId}'): + ('call-controls-for-me', 'get', ()), + }, + 'Webex Contact Center': { + ('flow', 'GET', '/flow-store/{orgId}/project/{projectId}/flows/{flowId}:export'): ('flow', 'export-legacy', ()), + ('flow', 'POST', '/flow-store/{orgId}/project/{projectId}/flows:import'): ('flow', 'import-legacy', ()), + ('contact-service-queue', 'GET', '/organization/{orgid}/contact-service-queue/by-skill-profile-id/{id}'): + ('contact-service-queue', 'list-by-skill-profile', ('list-skill-csqs-skill-profile',)), + ('contact-service-queue', 'POST', '/organization/{orgid}/contact-service-queue/delete-reference'): + ('contact-service-queue', 'delete-references', ('delete-csq-references',)), + ('contact-service-queue', 'POST', '/organization/{orgid}/contact-service-queue/fetch-manually-assignable-queues'): + ('contact-service-queue', 'list-manually-assignable', ('list-manually-assignable-csqs',)), + ('contact-service-queue', 'GET', '/organization/{orgid}/contact-service-queue/{id}/incoming-references'): + ('contact-service-queue', 'list-references', ('list-csq-references-id',)), + ('contact-service-queue', 'GET', '/organization/{orgid}/v2/contact-service-queue/by-user-id/{userid}/agent-based-queues'): + ('contact-service-queue', 'list-agent-based', ()), + ('contact-service-queue', 'GET', '/organization/{orgid}/v2/contact-service-queue/by-user-id/{userid}/skill-based-queues'): + ('contact-service-queue', 'list-skill-based', ()), + ('contact-service-queue', 'GET', '/organization/{orgid}/v2/contact-service-queue/by-user-id/{userid}/team-based-queues'): + ('contact-service-queue', 'list-team-based', ()), + ('contact-service-queue', 'POST', '/organization/{orgid}/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile'): + ('contact-service-queue', 'list-by-dynamic-skills', ('list-csqs-skills-profile',)), + ('contact-service-queue', 'POST', '/organization/{orgid}/contact-service-queue/fetch-by-userId-skillProfileId'): + ('contact-service-queue', 'list-by-user-skill-profile', ('list-csqs-user-profile',)), + ('outdial-ani', 'GET', '/organization/{orgid}/outdial-ani/entry'): + ('outdial-ani', 'list-entries', ('list-entry',)), + ('outdial-ani', 'POST', '/organization/{orgid}/outdial-ani/{outDialAniId}/entry/bulk'): + ('outdial-ani', 'bulk-save-entries', ('bulk-save-entry',)), + ('outdial-ani', 'GET', '/organization/{orgid}/v2/outdial-ani/{outDialAniId}/entry'): + ('outdial-ani', 'list-entries-for-ani', ('list-entry-2',)), + ('users', 'POST', '/organization/{orgid}/user/fetch-user-details-by-ids'): + ('users', 'list-by-ids', ('get-ids',)), + ('users', 'PATCH', '/organization/{orgid}/user/bulk/update-dynamic-skill/{skillId}'): + ('users', 'bulk-partial-update-dynamic-skills', ('bulk-update-dynamic-skills',)), + ('tasks', 'POST', '/v1/tasks/{taskId}/unhold'): + ('tasks', 'unhold', ('resume',)), + ('tasks', 'POST', '/v2/tasks/{taskId}/messages'): + ('tasks', 'append-message', ('update-2',)), + ('tasks', 'POST', '/v1/tasks/{taskId}/pause'): + ('tasks', 'pause-digital', ()), + ('tasks', 'POST', '/v1/tasks/{taskId}/resume'): + ('tasks', 'resume-digital', ()), + ('agent-personal-greeting-files', 'POST', '/organization/{orgid}/v2/agent-personal-greeting'): + ('agent-personal-greeting-files', 'create', ('create-v2-api',)), + ('agent-personal-greeting-files', 'POST', '/organization/{orgid}/agent-personal-greeting/delete-reference'): + ('agent-personal-greeting-files', 'delete-references', ('delete-references-1',)), + ('agent-personal-greeting-files', 'GET', '/organization/{orgid}/v2/agent-personal-greeting/{id}'): + ('agent-personal-greeting-files', 'get-id', ('get-id-v2-api',)), + ('agent-personal-greeting-files', 'PUT', '/organization/{orgid}/v2/agent-personal-greeting/{id}'): + ('agent-personal-greeting-files', 'update-id', ('update-id-v2-api',)), + ('agent-personal-greeting-files', 'DELETE', '/organization/{orgid}/v2/agent-personal-greeting/{id}'): + ('agent-personal-greeting-files', 'delete-id', ('delete-id-v2-api',)), + ('agent-personal-greeting-files', 'PATCH', '/organization/{orgid}/v2/agent-personal-greeting/{id}'): + ('agent-personal-greeting-files', 'patch-id', ('patch-id-v2-api',)), + ('activities', 'GET', '/{orgId}/project/{projectId}/v2/activities'): + ('activities', 'list-definitions', ()), + ('activities', 'GET', '/{orgId}/project/{projectId}/v2/activities/{activityName}'): + ('activities', 'describe', ()), + ('activities', 'GET', '/{orgId}/project/{projectId}/v2/activities/{activityName}/inputs/{inputName}/choices'): + ('activities', 'get-input-choices', ()), + ('events', 'GET', '/{orgId}/project/{projectId}/v2/event-specifications'): + ('events', 'list-specifications', ()), + ('flows', 'GET', '/flow-store/{orgId}/project/{projectId}/flows'): + ('flow', 'list', ()), + ('flows', 'POST', '/flow-store/{orgId}/project/{projectId}/flows/{flowId}:publish'): + ('flow', 'publish', ()), + ('flows', 'POST', '/flow-store/{orgId}/project/{projectId}/flows/{flowId}:lock'): + ('flow', 'lock', ()), + ('flows', 'POST', '/flow-store/{orgId}/project/{projectId}/flows/{flowId}:unlock'): + ('flow', 'unlock', ()), + ('flows', 'POST', '/flow-store/{orgId}/project/{projectId}/v2/flows:validate'): + ('flow', 'validate', ()), + ('flows', 'POST', '/flow-store/{orgId}/project/{projectId}/v2/flows:import'): + ('flow', 'import', ()), + ('flows', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/flows/{flowId}'): + ('flow', 'get', ()), + ('flows', 'POST', '/flow-store/{orgId}/project/{projectId}/v2/flows/{flowId}'): + ('flow', 'save-draft', ()), + ('flows', 'PATCH', '/flow-store/{orgId}/project/{projectId}/v2/flows/{flowId}'): + ('flow', 'patch-draft', ()), + ('flows', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/flows/{flowId}:validate'): + ('flow', 'validate-draft', ()), + ('flows', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/flows/{flowId}:export'): + ('flow', 'export', ()), + ('flows', 'GET', '/{orgId}/project/{projectId}/flows'): + ('flow', 'list', ()), + ('flows', 'POST', '/{orgId}/project/{projectId}/flows/{flowId}:publish'): + ('flow', 'publish', ()), + ('flows', 'POST', '/{orgId}/project/{projectId}/flows/{flowId}:lock'): + ('flow', 'lock', ()), + ('flows', 'POST', '/{orgId}/project/{projectId}/flows/{flowId}:unlock'): + ('flow', 'unlock', ()), + ('flows', 'POST', '/{orgId}/project/{projectId}/v2/flows:validate'): + ('flow', 'validate', ()), + ('flows', 'POST', '/{orgId}/project/{projectId}/v2/flows:import'): + ('flow', 'import', ()), + ('flows', 'GET', '/{orgId}/project/{projectId}/v2/flows/{flowId}'): + ('flow', 'get', ()), + ('flows', 'POST', '/{orgId}/project/{projectId}/v2/flows/{flowId}'): + ('flow', 'save-draft', ()), + ('flows', 'PATCH', '/{orgId}/project/{projectId}/v2/flows/{flowId}'): + ('flow', 'patch-draft', ()), + ('flows', 'GET', '/{orgId}/project/{projectId}/v2/flows/{flowId}:validate'): + ('flow', 'validate-draft', ()), + ('flows', 'GET', '/{orgId}/project/{projectId}/v2/flows/{flowId}:export'): + ('flow', 'export', ()), + ('flows', 'GET', '/{orgId}/project/{projectId}/flows:search'): + ('flow', 'search', ()), + ('flows', 'DELETE', '/{orgId}/project/{projectId}/flows/{flowId}'): + ('flow', 'delete', ()), + ('functions', 'GET', '/v1/{orgId}/functions'): + ('functions', 'list', ()), + ('functions', 'POST', '/v1/{orgId}/functions'): + ('functions', 'create', ()), + ('functions', 'GET', '/v1/{orgId}/functions/{id}'): + ('functions', 'get', ()), + ('functions', 'PUT', '/v1/{orgId}/functions/{id}'): + ('functions', 'update', ()), + ('functions', 'DELETE', '/v1/{orgId}/functions/{id}'): + ('functions', 'delete', ()), + ('functions', 'POST', '/v1/{orgId}/functions:import'): + ('functions', 'import', ()), + ('functions', 'POST', '/v1/{orgId}/functions/{id}:unlock'): + ('functions', 'unlock', ()), + ('functions', 'POST', '/v1/{orgId}/functions/{id}:lock'): + ('functions', 'lock', ()), + ('functions', 'POST', '/v1/{orgId}/functions/{id}:test'): + ('functions', 'test', ()), + ('functions', 'POST', '/v1/{orgId}/functions/{id}:publish'): + ('functions', 'publish', ()), + ('functions', 'POST', '/v1/{orgId}/functions/{id}:export'): + ('functions', 'export', ()), + ('legacy-flows', 'GET', '/flow-store/{orgId}/project/{projectId}/flows/{flowId}:export'): + ('flow', 'export-legacy', ()), + ('legacy-flows', 'POST', '/flow-store/{orgId}/project/{projectId}/flows:import'): + ('flow', 'import-legacy', ()), + ('templates', 'GET', '/templates'): + ('templates', 'list-flow', ()), + ('templates', 'GET', '/templates/{id}'): + ('templates', 'get-flow', ()), + ('usage-reports', 'GET', '/v1/usage-reports/resource-types'): + ('usage-reports', 'list-resource-types', ()), + ('activities', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/activities'): + ('activities', 'list-definitions', ()), + ('activities', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/activities/{activityName}'): + ('activities', 'describe', ()), + ('activities', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/activities/{activityName}/inputs/{inputName}/choices'): + ('activities', 'get-input-choices', ()), + ('events', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/event-specifications'): + ('events', 'list-specifications', ()), + ('functions', 'GET', '/v1/{orgId}/functions/options'): + ('functions', 'list-options', ()), + ('templates', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/templates'): + ('templates', 'list-flow', ()), + ('templates', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/templates/{id}'): + ('templates', 'get-flow', ()), + ('usage-reports', 'POST', '/v1/usage-reports'): + ('usage-reports', 'create', ()), + ('usage-reports', 'GET', '/v1/usage-reports'): + ('usage-reports', 'list', ()), + ('usage-reports', 'GET', '/v1/usage-reports/{reportId}'): + ('usage-reports', 'get', ()), + ('usage-reports', 'DELETE', '/v1/usage-reports/{reportId}'): + ('usage-reports', 'delete', ()), + ('usage-reports', 'GET', '/v1/usage-reports/{fileId}/download'): + ('usage-reports', 'download-file', ()), + }, + 'Webex Messaging': { + ('hybrid-data-security', 'GET', '/hds/organizations/{organizationId}'): + ('hds', 'get-org', ()), + ('hybrid-data-security', 'GET', '/hds/organizations/{organizationId}/clusters'): + ('hds', 'list-clusters-org', ()), + ('hybrid-data-security', 'GET', '/hds/clusters/{clusterId}'): + ('hds', 'get-cluster', ()), + ('hybrid-data-security', 'GET', '/hds/clusters/{clusterId}/nodes'): + ('hds', 'list-nodes-cluster', ()), + ('hybrid-data-security', 'GET', '/hds/nodes/{nodeId}'): + ('hds', 'get-node', ()), + ('hybrid-data-security', 'GET', '/hds/organizations/{organizationId}/database'): + ('hds', 'get-database-config-org', ()), + ('hybrid-data-security', 'GET', '/hds/organizations/{organizationId}/tenants'): + ('hds', 'list-tenants-org', ()), + ('hybrid-data-security', 'GET', '/hds/nodes/{nodeId}/alarms'): + ('hds', 'get-alarms-node', ()), + ('hybrid-data-security', 'GET', '/hds/testResults/nodes/{nodeId}/networkTest'): + ('hds', 'get-test-results-node', ()), + ('hybrid-data-security', 'GET', '/hds/nodes/{nodeId}/resourceUsage'): + ('hds', 'get-usage-node', ()), + ('hybrid-data-security', 'GET', '/hds/clusters/{clusterId}/availability'): + ('hds', 'get-availability-cluster', ()), + ('hds', 'GET', '/hds/testResults/nodes/{nodeId}/networkTest'): + ('hds', 'get-test-results-node', ()), + ('hds', 'GET', '/hds/clusters/{clusterId}'): + ('hds', 'get-cluster', ()), + ('hds', 'GET', '/hds/organizations/{organizationId}'): + ('hds', 'get-org', ()), + ('hds', 'GET', '/hds/nodes/{nodeId}'): + ('hds', 'get-node', ()), + ('hds', 'GET', '/hds/organizations/{organizationId}/database/details'): + ('hds', 'get-database-org', ()), + ('hds', 'GET', '/hds/organizations/{organizationId}/multiTenant'): + ('hds', 'get-multi-tenant-org', ()), + ('hds', 'GET', '/hds/clusters/{clusterId}/availability'): + ('hds', 'get-availability-cluster', ()), + ('hds', 'GET', '/hds/organizations/{organizationId}/database'): + ('hds', 'get-database-config-org', ('get-database-org-2',)), + ('hds', 'GET', '/hds/organizations/{organizationId}/tenants'): + ('hds', 'list-tenants-org', ('get-multi-tenant-org-2',)), + ('hds', 'GET', '/hds/clusters/{clusterId}/nodes'): + ('hds', 'list-nodes-cluster', ()), + ('hds', 'GET', '/hds/organizations/{organizationId}/clusters'): + ('hds', 'list-clusters-org', ()), + ('hds', 'GET', '/hds/nodes/{nodeId}/alarms'): + ('hds', 'get-alarms-node', ()), + ('hds', 'GET', '/hds/nodes/{nodeId}/resourceUsage'): + ('hds', 'get-usage-node', ()), + }, +} + +GROUP_ALIASES = {'Webex Contact Center': {'flow': ['flows']}, 'Webex Messaging': {'hds': ['hybrid-data-security']}} + +# Place user-facing commands by product while retaining upstream collections. +COLLECTION_MOVES = {("Webex Admin", "metrics"): "Webex Cloud Calling"} + +# Drop these duplicate source requests in favor of the listed unprefixed request. +# Preserve the replacement request's body and query contract (not just its URL). +# Fail extraction if a replacement disappears in a future collection refresh. +SUPERSEDED_ROUTES = { + "Webex Contact Center": { + ('flow', 'GET', '/flow-store/{orgId}/project/{projectId}/flows'): + ('GET', '/{orgId}/project/{projectId}/flows'), + ('flow', 'POST', '/flow-store/{orgId}/project/{projectId}/flows/{flowId}:publish'): + ('POST', '/{orgId}/project/{projectId}/flows/{flowId}:publish'), + ('activities', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/activities'): + ('GET', '/{orgId}/project/{projectId}/v2/activities'), + ('activities', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/activities/{activityName}'): + ('GET', '/{orgId}/project/{projectId}/v2/activities/{activityName}'), + ('activities', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/activities/{activityName}/inputs/{inputName}/choices'): + ('GET', '/{orgId}/project/{projectId}/v2/activities/{activityName}/inputs/{inputName}/choices'), + ('events', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/event-specifications'): + ('GET', '/{orgId}/project/{projectId}/v2/event-specifications'), + ('flows', 'GET', '/flow-store/{orgId}/project/{projectId}/flows'): + ('GET', '/{orgId}/project/{projectId}/flows'), + ('flows', 'POST', '/flow-store/{orgId}/project/{projectId}/flows/{flowId}:publish'): + ('POST', '/{orgId}/project/{projectId}/flows/{flowId}:publish'), + ('flows', 'POST', '/flow-store/{orgId}/project/{projectId}/flows/{flowId}:lock'): + ('POST', '/{orgId}/project/{projectId}/flows/{flowId}:lock'), + ('flows', 'POST', '/flow-store/{orgId}/project/{projectId}/flows/{flowId}:unlock'): + ('POST', '/{orgId}/project/{projectId}/flows/{flowId}:unlock'), + ('flows', 'POST', '/flow-store/{orgId}/project/{projectId}/v2/flows:validate'): + ('POST', '/{orgId}/project/{projectId}/v2/flows:validate'), + ('flows', 'POST', '/flow-store/{orgId}/project/{projectId}/v2/flows:import'): + ('POST', '/{orgId}/project/{projectId}/v2/flows:import'), + ('flows', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/flows/{flowId}'): + ('GET', '/{orgId}/project/{projectId}/v2/flows/{flowId}'), + ('flows', 'POST', '/flow-store/{orgId}/project/{projectId}/v2/flows/{flowId}'): + ('POST', '/{orgId}/project/{projectId}/v2/flows/{flowId}'), + ('flows', 'PATCH', '/flow-store/{orgId}/project/{projectId}/v2/flows/{flowId}'): + ('PATCH', '/{orgId}/project/{projectId}/v2/flows/{flowId}'), + ('flows', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/flows/{flowId}:validate'): + ('GET', '/{orgId}/project/{projectId}/v2/flows/{flowId}:validate'), + ('flows', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/flows/{flowId}:export'): + ('GET', '/{orgId}/project/{projectId}/v2/flows/{flowId}:export'), + ('templates', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/templates'): + ('GET', '/templates'), + ('templates', 'GET', '/flow-store/{orgId}/project/{projectId}/v2/templates/{id}'): + ('GET', '/templates/{id}'), + }, +} diff --git a/codegen/test_naming_overrides.py b/codegen/test_naming_overrides.py new file mode 100644 index 0000000..b422fe9 --- /dev/null +++ b/codegen/test_naming_overrides.py @@ -0,0 +1,108 @@ +"""Regression checks for route-based names and compatibility across refreshes.""" +import copy +import unittest +import json +from pathlib import Path + +from extract_api_spec import extract_collection, merge_folders, apply_naming_overrides +from naming_overrides import NAMING_OVERRIDES + + +class NamingOverridesTest(unittest.TestCase): + @classmethod + def setUpClass(cls): + cls.raw = {} + for path in (Path(__file__).parent / 'postman').glob('*.json'): + name, folders = extract_collection(path) + cls.raw[name] = merge_folders(folders) + + def resolved(self, area): + return apply_naming_overrides(area, self.raw[area]) + + def command(self, area, group, name): + folder = next(g for g in self.resolved(area) if g['group'] == group) + return next(e for e in folder['endpoints'] + if name in [e['command'], *e.get('aliases', [])]) + + def test_every_override_matches_a_collection_endpoint(self): + for area, overrides in NAMING_OVERRIDES.items(): + identities = {(g['group'], e['method'], e['path']) + for g in self.raw[area] for e in g['endpoints']} + self.assertFalse(set(overrides) - identities, area) + + def test_names_do_not_depend_on_numeric_collision_suffixes(self): + for area, overrides in NAMING_OVERRIDES.items(): + folders = copy.deepcopy(self.raw[area]) + # Simulate Postman reordering/name normalization changes. Explicit + # routes must keep their public names regardless of generated names. + for g in folders: + for e in g['endpoints']: + if (g['group'], e['method'], e['path']) in overrides: + e['command'] = 'upstream-renamed-99' + self.assertEqual(self.resolved(area), apply_naming_overrides(area, folders)) + + def test_voice_resume_keeps_its_original_meaning(self): + area = 'Webex Contact Center' + self.assertEqual(self.command(area, 'tasks', 'resume')['path'], '/v1/tasks/{taskId}/unhold') + self.assertEqual(self.command(area, 'tasks', 'resume-digital')['path'], '/v1/tasks/{taskId}/resume') + self.assertEqual(self.command(area, 'tasks', 'resume-recording')['path'], '/v1/tasks/{taskId}/record/resume') + + def test_flow_versions_and_routes_remain_distinct(self): + area = 'Webex Contact Center' + self.assertEqual(self.command(area, 'flow', 'import-legacy')['path'], + '/flow-store/{orgId}/project/{projectId}/flows:import') + self.assertEqual(self.command(area, 'flow', 'import')['path'], + '/{orgId}/project/{projectId}/v2/flows:import') + + def test_current_flow_routes_are_consolidated(self): + for group in self.resolved('Webex Contact Center'): + if group['group'] not in ('flow', 'activities', 'events', 'templates'): + continue + for ep in group['endpoints']: + self.assertFalse(ep['command'].endswith('-direct')) + if not ep['command'].endswith('-legacy'): + self.assertFalse(ep['path'].startswith('/flow-store/')) + choices = self.command('Webex Contact Center', 'activities', 'get-input-choices') + self.assertIn('search', [p['name'] for p in choices['query_params']]) + self.assertNotIn('mode', [p['name'] for p in choices['query_params']]) + self.assertEqual(self.command('Webex Contact Center', 'templates', 'list-flow')['path'], '/templates') + + def test_missing_replacement_route_fails_extraction(self): + area = 'Webex Contact Center' + folders = copy.deepcopy(self.raw[area]) + for folder in folders: + folder['endpoints'] = [e for e in folder['endpoints'] if e['path'] != '/templates'] + with self.assertRaisesRegex(ValueError, 'Missing replacement'): + apply_naming_overrides(area, folders) + + def test_hds_duplicates_are_merged_but_distinct_routes_survive(self): + groups = self.resolved('Webex Messaging') + self.assertNotIn('hybrid-data-security', [g['group'] for g in groups]) + hds = next(g for g in groups if g['group'] == 'hds') + self.assertEqual(len(hds['endpoints']), 13) + self.assertEqual(len({(e['method'], e['path']) for e in hds['endpoints']}), 13) + self.assertIn('hybrid-data-security', hds['aliases']) + + def test_new_scoped_call_controls(self): + for name in ['dial', 'answer', 'hangup', 'list', 'get']: + ep = self.command('Webex Cloud Calling', 'call-controls-for-me', name) + self.assertIn('/members/me/', ep['path']) + + def test_metrics_move_preserves_analytics_host(self): + from generate_cli import resolve_base_url + spec = json.loads((Path(__file__).parent / 'api_spec.json').read_text()) + self.assertFalse(any(g['group'] in ('metrics', 'calling-metrics') for g in spec['Webex Admin'])) + group = next(g for g in spec['Webex Cloud Calling'] if g['group'] == 'metrics') + ep = group['endpoints'][0] + self.assertEqual(ep['command'], 'get-call-quality-stats') + self.assertEqual(resolve_base_url('Webex Cloud Calling', ep['path'], 'wrong-host'), + 'config.AnalyticsBaseURL') + + def test_queue_names_keep_selection_method_without_parameter_suffixes(self): + for name in ['list-agent-based', 'list-skill-based', 'list-team-based', + 'list-by-skill-profile', 'list-by-dynamic-skills', 'list-by-user-skill-profile']: + self.command('Webex Contact Center', 'contact-service-queue', name) + + +if __name__ == '__main__': + unittest.main() diff --git a/site/README.md b/site/README.md index 1b7f5c3..3f00773 100644 --- a/site/README.md +++ b/site/README.md @@ -1,49 +1,11 @@ -# Starlight Starter Kit: Basics +# Webex CLI documentation site -[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build) +Astro/Starlight source for the published Webex CLI documentation. Area reference pages live in `src/content/docs/`; update them alongside README and the handwritten sections of `../skill/*/SKILL.md` when commands change. `make codegen` from the repository root regenerates skill command tables, but does not regenerate these site pages. +```bash +npm ci +npm run dev +npm run build ``` -npm create astro@latest -- --template starlight -``` - -> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! - -## 🚀 Project Structure - -Inside of your Astro + Starlight project, you'll see the following folders and files: - -``` -. -├── public/ -├── src/ -│ ├── assets/ -│ ├── content/ -│ │ └── docs/ -│ └── content.config.ts -├── astro.config.mjs -├── package.json -└── tsconfig.json -``` - -Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name. - -Images can be added to `src/assets/` and embedded in Markdown with a relative link. - -Static assets, like favicons, can be placed in the `public/` directory. - -## 🧞 Commands - -All commands are run from the root of the project, from a terminal: - -| Command | Action | -| :------------------------ | :----------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:4321` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | -| `npm run astro -- --help` | Get help using the Astro CLI | - -## 👀 Want to learn more? -Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat). +Build output is `dist/`. The repository Pages workflow publishes the site. The Postman refresh inventory and command migration map are maintained in `../codegen/INVENTORY.md` and `../codegen/NAMING.md`. diff --git a/site/src/content/docs/admin.mdx b/site/src/content/docs/admin.mdx index a11b07e..d763cde 100644 --- a/site/src/content/docs/admin.mdx +++ b/site/src/content/docs/admin.mdx @@ -95,3 +95,9 @@ webex admin hybrid-clusters list # SCIM user provisioning webex admin scim-2-users list ``` + +## Refreshed administration APIs + +`archive-users query` retrieves archived users. `identity-org update-authentication-configuration-settings` and `identity-org update-password-policy` update organization identity policies. Check each command's help for required schemas and authorization. + +`recordings query` and `recordings query-admin-compliance-officer` accept recording search filters in a JSON request body. These are POST requests, including when used through MCP. Calling quality statistics are available under `webex calling metrics get-call-quality-stats`. diff --git a/site/src/content/docs/agent-skill.mdx b/site/src/content/docs/agent-skill.mdx index 8d15266..cc23f23 100644 --- a/site/src/content/docs/agent-skill.mdx +++ b/site/src/content/docs/agent-skill.mdx @@ -86,3 +86,9 @@ The skill can be customized — just ask your coding agent to modify it. For exa - [Claude Code skills](https://code.claude.com/docs/en/skills) - [OpenAI Codex skills](https://developers.openai.com/codex/skills/) - [Cursor skills](https://cursor.com/docs/context/skills) + +## Keeping command references current + +`make codegen` refreshes the generated command tables for all six repository sub-skills. Handwritten guidance documents flow format migration, compatibility aliases, new command groups, and known upload limitations. Install the skills from the same CLI revision you use; older installed copies may show names removed by the refresh. + +For the reviewed refresh inventory and old-to-new command map, see [INVENTORY.md](https://github.com/Cloverhound/webex-cli/blob/main/codegen/INVENTORY.md) and [NAMING.md](https://github.com/Cloverhound/webex-cli/blob/main/codegen/NAMING.md) in the repository. diff --git a/site/src/content/docs/calling.mdx b/site/src/content/docs/calling.mdx index 09ede26..d3623e5 100644 --- a/site/src/content/docs/calling.mdx +++ b/site/src/content/docs/calling.mdx @@ -9,6 +9,10 @@ The `webex calling` subcommand provides access to the Webex Calling API. No `--o | Resource | Description | |----------|-------------| +| `customer-assist` | Customer Assist configuration | +| `mode-management` | Operating mode management | +| `call-controls-for-me` | Authenticated user call controls | +| `metrics` | Aggregated call and media-quality statistics | | `announcement-playlist` | Announcement playlist management | | `announcement-repository` | Announcement repository management | | `auto-attendant` | Auto attendant / IVR configuration | @@ -167,3 +171,15 @@ webex calling workspace-call update-busy-voicemail-greeting-place --workspace-id webex calling workspace-call update-no-answer-voicemail-greeting-place --workspace-id --file greeting.wav webex calling workspace-call upload-intercept-announcement-file --workspace-id --file greeting.wav ``` + +## Personal call controls and quality metrics + +Use `webex calling call-controls-for-me` for `/members/me/` operations: `dial`, `answer`, `hangup`, `list`, and `get`. Existing `call-controls` operations retain their separate routes. + +```bash +webex calling call-controls-for-me list +webex calling call-controls-for-me get --call-id +webex calling metrics get-call-quality-stats --help +``` + +`metrics get-call-quality-stats` queries the analytics host for aggregated call/media quality. It requires Pro Pack, analytics permissions, and an administrator role. Each query covers up to seven days within the previous three weeks. This operation is grouped under Calling even though its upstream collection is Admin. diff --git a/site/src/content/docs/cc.mdx b/site/src/content/docs/cc.mdx index 3f2696c..bc7e2e1 100644 --- a/site/src/content/docs/cc.mdx +++ b/site/src/content/docs/cc.mdx @@ -9,6 +9,16 @@ The `webex cc` subcommand provides access to the Webex Contact Center API. The ` | Resource | Description | |----------|-------------| +| `activities` | Flow activity schemas and input choices | +| `asset` | Work-item and custom-messaging assets | +| `campaign-group` | Campaign group membership | +| `channel` | Custom channel configuration | +| `events` | Flow event specifications | +| `external-data-updates` | Completed task numeric global-variable updates | +| `functions` | Custom flow functions | +| `search-metadata` | Search GraphQL schema discovery | +| `templates` | Flow templates | +| `usage-reports` | Asynchronous resource usage exports | | `address-book` | Address books | | `agent-personal-greeting-files` | Agent personal greeting file management | | `agent-summaries` | Agent summary reports | @@ -35,7 +45,7 @@ The `webex cc` subcommand provides access to the Webex Contact Center API. The ` | `dnc-management` | Do-not-call list management | | `entry-point` | Inbound entry points (voice, chat, email, social) | | `estimated-wait-time` | Estimated wait time configuration | -| `flow` | Flow export/import/publish | +| `flow` | Draft authoring, validation, import/export, and publication | | `generated-summaries` | AI-generated summary management | | `global-variables` | Flow global variables | | `holiday-list` | Holiday lists | @@ -144,3 +154,50 @@ Most resources use `list` as the list subcommand. One exception: | `dial-number` | `list-dialed-mapping` | Use `--help` on any resource to see its available subcommands. + +## Flow authoring and migration + +Current flow commands use the unprefixed Contact Center routes. `flow` is the canonical group; `flows` is an alias. Import/export now use the typed FlowV2 JSON contract, not legacy FDL. Existing automation consuming raw FDL must use `export-legacy` instead. + +```bash +webex cc flow list +webex cc flow get --flow-id +webex cc flow export --flow-id --version draft > flow.json +webex cc flow validate --body-file flow.json +webex cc flow import --body-file flow.json --overwrite false --flow-type FLOW +webex cc flow patch-draft --flow-id --body-file patch.json +webex cc flow export-legacy --flow-id > legacy-flow.json +webex cc activities list-definitions +webex cc events list-specifications +webex cc templates list-flow +``` + +Bodies must be supplied with `--body` or `--body-file`; these generated commands do not read stdin. The CLI uses the fixed project ID internally. `--organization` overrides the login organization. + +Cloverhound checks verified reads and an unpublished disposable draft's import, lock/unlock, patch, save, export, and deletion across both URL forms. The draft was deleted and both routes returned 404 afterward. Publish was not live-tested. Templates use `/templates`; the scoped prefixed template list returned 404. + +**Import limitations:** `flow import-legacy` and `functions import` are exposed but their generated commands do not implement the required upload body. Do not use them for migration until upload handling is implemented. Current `flow import --body-file` was live-tested successfully. + +## Other refreshed Contact Center APIs + +| Group | Purpose | +| --- | --- | +| `activities`, `events`, `templates` | Discover activity schemas, event schemas, input choices, and starter flows. | +| `functions` | Manage custom function source, drafts, locks, versions, and publish tags. `test` implicitly publishes the draft before execution. | +| `asset`, `channel` | Configure work-item/custom-messaging resources and their references. | +| `campaign-group` | List campaigns belonging to a campaign group. | +| `search-metadata` | Discover supported Search GraphQL fields and operations. | +| `usage-reports` | Discover resource types, request asynchronous CSV exports, inspect status, and download files. | +| `external-data-updates` | Update numeric global-variable values on tasks completed within the preceding two days. | + +```bash +webex cc usage-reports list-resource-types +webex cc usage-reports create --body-file report-request.json +webex cc usage-reports get --report-id +webex cc usage-reports download-file --file-id --output raw > report.bin +webex cc external-data-updates update-task-global-variables --body-file task-update.json +``` + +Discover report types before creating a report; the collection does not enumerate the types or CSV columns. Download with `fileId`, not `reportId`. Reports can span available data up to 36 months, may split into monthly files, and expire seven days after completion. Only one report processes per organization at a time. + +For task controls, `unhold` (alias `resume`) resumes a held voice call; `pause-digital` and `resume-digital` handle paused non-real-time digital tasks. `append-message` retains `update-2` as an alias. Queue lookups use `list-agent-based`, `list-skill-based`, `list-team-based`, `list-by-skill-profile`, `list-by-dynamic-skills`, and `list-by-user-skill-profile`; pass IDs as flags. Whisper coaching is beta. The refresh also adds conference-participant removal, campaign-time lookup, and contact closure across a campaign chain. diff --git a/site/src/content/docs/device.mdx b/site/src/content/docs/device.mdx index 72f1b7a..64c7de1 100644 --- a/site/src/content/docs/device.mdx +++ b/site/src/content/docs/device.mdx @@ -9,6 +9,7 @@ The `webex device` subcommand provides access to the Webex Device APIs for manag | Resource | Description | |----------|-------------| +| `locations` | Location management | | `device-call` | Device call settings | | `device-configurations` | Device configuration management | | `devices` | Device provisioning and management | diff --git a/site/src/content/docs/index.mdx b/site/src/content/docs/index.mdx index c3c78db..030b628 100644 --- a/site/src/content/docs/index.mdx +++ b/site/src/content/docs/index.mdx @@ -21,10 +21,10 @@ import { Card, CardGrid } from '@astrojs/starlight/components'; Manage organizations, people, licenses, roles, groups, hybrid services, SCIM provisioning, and more. - Manage people, locations, devices, call queues, hunt groups, auto attendants, PSTN, and more via the Webex Calling API. + Manage people, locations, devices, call queues, personal call controls, quality metrics, hunt groups, auto attendants, PSTN, and more via the Webex Calling API. - Administer sites, teams, users, queues, entry points, skills, flows, campaigns, AI features, and the full WxCC configuration. + Administer sites, teams, users, queues, entry points, skills, flow drafts, custom functions, usage reports, campaigns, AI features, and the full WxCC configuration. Manage devices, workspaces, configurations, xAPI commands, hot desking, and workspace personalization. @@ -33,7 +33,7 @@ import { Card, CardGrid } from '@astrojs/starlight/components'; Manage meetings, recordings, transcripts, participants, polls, Q&A, Slido, video mesh, and webhooks. - Manage rooms, messages, memberships, teams, webhooks, and attachment actions via the Messaging API. + Manage rooms, messages, memberships, teams, webhooks, Hybrid Data Security, and attachment actions via the Messaging API. Browser-based OAuth login with tokens stored securely in your OS keyring. Multi-user support. diff --git a/site/src/content/docs/meetings.mdx b/site/src/content/docs/meetings.mdx index d73d3fc..6cf73db 100644 --- a/site/src/content/docs/meetings.mdx +++ b/site/src/content/docs/meetings.mdx @@ -9,6 +9,7 @@ The `webex meetings` subcommand provides access to the Webex Meetings APIs for m | Resource | Description | |----------|-------------| +| `slidosecurepremium` | Slido Secure Premium operations | | `chats` | Meeting chat management | | `closed-captions` | Closed caption management | | `invitees` | Meeting invitee management | @@ -92,3 +93,9 @@ webex meetings recordings download --recording-id --output meeting.mp3 --ho ``` The `--type` flag selects which `temporaryDirectDownloadLinks` field to use: `audioDownloadLink` (default), `recordingDownloadLink`, or `transcriptDownloadLink`. + +## Group meetings and recording queries + +Service apps with group meeting access can use `meetings list-group`, `meetings patch-group`, and `meetings update-group-control-status` to find/update meetings and control recording. The caller must satisfy the API's group/site access requirements. + +`recordings query` and `recordings query-admin-compliance-officer` search recordings using filters in a JSON request body. These searches use POST and therefore the MCP `webex_write` dispatcher. diff --git a/site/src/content/docs/messaging.mdx b/site/src/content/docs/messaging.mdx index e9cd941..8cb16f0 100644 --- a/site/src/content/docs/messaging.mdx +++ b/site/src/content/docs/messaging.mdx @@ -62,3 +62,16 @@ webex messaging webhooks list # List room memberships webex messaging memberships list --room-id "ROOM_ID" ``` + +## Hybrid Data Security + +Use `webex messaging hds` (`hybrid-data-security` is a group alias) to inspect organizations, clusters, nodes, network-test results, alarms, and resource usage. The overlapping upstream groups are consolidated. + +```bash +webex messaging hds list-clusters-org --organization-id +webex messaging hds list-nodes-cluster --cluster-id +webex messaging hds get-alarms-node --node-id +webex messaging hds get-usage-node --node-id +``` + +Distinct older routes remain separate: `get-database-org` versus `get-database-config-org`, and `get-multi-tenant-org` versus `list-tenants-org`. Existing numeric spellings remain aliases for the latter two operations. diff --git a/skill/SKILL.md b/skill/SKILL.md index 218b992..d12c477 100644 --- a/skill/SKILL.md +++ b/skill/SKILL.md @@ -99,7 +99,7 @@ Most CC resources use a consistent `list` subcommand. A few exceptions remain: |---|---|---| | `dial-number` | `list-dialed-mapping` | Exception — descriptive name | | `agents` | (none) | Agent operations: login, logout, state-change, etc. | -| `flow` | (none) | Only export/import/publish | +| `flow` | `list` | Draft authoring, current-format import/export, explicit legacy commands | All other CC resources (site, team, users, global-variables, business-hour, audio-files, work-types, etc.) use `list`. @@ -205,7 +205,7 @@ webex calling converged-recordings download --recording-id --output call.mp webex cc site list webex cc contact-service-queue list webex cc entry-point list -webex cc flow export --id --output flow.json +webex cc flow export --flow-id --version draft > flow.json webex cc audio-files download --id --output prompt.wav webex cc audio-files upload --file prompt.wav --name "Main Greeting" @@ -227,6 +227,30 @@ webex messaging messages list --room-id webex messaging messages create --body '{"roomId":"","text":"Hello!"}' ``` +## Flow authoring and migration + +Current flow commands use the unprefixed Contact Center routes. `flow` is the canonical group; `flows` is an alias. Import/export now use the typed FlowV2 JSON contract, not legacy FDL. Existing automation consuming raw FDL must use `export-legacy` instead. + +```bash +webex cc flow list +webex cc flow get --flow-id +webex cc flow export --flow-id --version draft > flow.json +webex cc flow validate --body-file flow.json +webex cc flow import --body-file flow.json --overwrite false --flow-type FLOW +webex cc flow patch-draft --flow-id --body-file patch.json +webex cc flow export-legacy --flow-id > legacy-flow.json +webex cc activities list-definitions +webex cc events list-specifications +webex cc templates list-flow +``` + +Bodies must be supplied with `--body` or `--body-file`; these generated commands do not read stdin. The CLI uses the fixed project ID internally. `--organization` overrides the login organization. + +Cloverhound checks verified reads and an unpublished disposable draft's import, lock/unlock, patch, save, export, and deletion across both URL forms. The draft was deleted and both routes returned 404 afterward. Publish was not live-tested. Templates use `/templates`; the scoped prefixed template list returned 404. + +**Import limitations:** `flow import-legacy` and `functions import` are exposed but their generated commands do not implement the required upload body. Do not use them for migration until upload handling is implemented. Current `flow import --body-file` was live-tested successfully. + + ## Filtering and Pagination CC list endpoints support RSQL filtering: diff --git a/skill/admin/SKILL.md b/skill/admin/SKILL.md index f82e2f3..96e8995 100644 --- a/skill/admin/SKILL.md +++ b/skill/admin/SKILL.md @@ -256,10 +256,17 @@ webex admin service-apps get --service-app-id 6. **Partner admins** — use `--organization ` global flag to manage a customer org. The org ID can be base64 or UUID format; the CLI auto-decodes. +## Refreshed administration APIs + +`archive-users query` retrieves archived users. `identity-org update-authentication-configuration-settings` and `identity-org update-password-policy` update organization identity policies. Check each command's help for required schemas and authorization. + +`recordings query` and `recordings query-admin-compliance-officer` accept recording search filters in a JSON request body. These are POST requests, including when used through MCP. Calling quality statistics are available under `webex calling metrics get-call-quality-stats`. + ## Command Reference > Auto-generated from Postman collections. Run `make codegen` to update. +> Organization defaults to the authenticated account; use `--organization` to override. ### admin-audit @@ -299,21 +306,21 @@ webex admin service-apps get --service-app-id | Command | Flags | |---|---| -| `get-verification-token` | `--org-id` *(required)*, `--domain`, `--body`, `--body-file` | -| `verify` | `--org-id` *(required)*, `--domain`, `--claim-domain`, `--reserve-domain`, `--body`, `--body-file` | -| `claim` | `--org-id` *(required)*, `--body`, `--body-file` | -| `unverify` | `--org-id` *(required)*, `--domain`, `--remove-pending`, `--body`, `--body-file` | -| `unclaim` | `--org-id` *(required)*, `--domain`, `--body`, `--body-file` | +| `get-verification-token` | `--domain`, `--body`, `--body-file` | +| `verify` | `--domain`, `--claim-domain`, `--reserve-domain`, `--body`, `--body-file` | +| `claim` | `--body`, `--body-file` | +| `unverify` | `--domain`, `--remove-pending`, `--body`, `--body-file` | +| `unclaim` | `--domain`, `--body`, `--body-file` | ### identity-org | Command | Flags | |---|---| -| `get` | `--org-id` *(required)* | -| `generate-otp` | `--org-id` *(required)*, `--user-id` *(required)* | -| `update` | `--org-id` *(required)*, `--schemas`, `--display-name`, `--preferred-language`, `--body`, `--body-file` | -| `update-authentication-configuration-settings` | `--org-id` *(required)*, `--schemas`, `--remember-my-login-id`, `--remember-my-login-id-duration`, `--mfa-enabled`, `--body`, `--body-file` | -| `update-password-policy` | `--org-id` *(required)*, `--schemas`, `--minimum-numeric`, `--minimum-cap-alpha`, `--minimum-low-alpha`, `--minimum-special`, `--minimum-length`, `--history-count`, `--max-password-age`, `--not-acceptable-strings`, `--body`, `--body-file` | +| `get` | — | +| `generate-otp` | `--user-id` *(required)* | +| `update` | `--schemas`, `--display-name`, `--preferred-language`, `--body`, `--body-file` | +| `update-authentication-configuration-settings` | `--schemas`, `--remember-my-login-id`, `--remember-my-login-id-duration`, `--mfa-enabled`, `--body`, `--body-file` | +| `update-password-policy` | `--schemas`, `--minimum-numeric`, `--minimum-cap-alpha`, `--minimum-low-alpha`, `--minimum-special`, `--minimum-length`, `--history-count`, `--max-password-age`, `--not-acceptable-strings`, `--body`, `--body-file` | ### events @@ -380,30 +387,30 @@ webex admin service-apps get --service-app-id | Command | Flags | |---|---| -| `get` | `--org-id` *(required)*, `--contact-id` *(required)* | -| `list` | `--org-id` *(required)*, `--keyword`, `--source`, `--limit`, `--group-ids` | -| `create` | `--org-id` *(required)*, `--body`, `--body-file` | -| `bulk-create-update` | `--org-id` *(required)*, `--body`, `--body-file` | -| `bulk-delete` | `--org-id` *(required)*, `--schemas`, `--object-ids`, `--body`, `--body-file` | -| `update` | `--org-id` *(required)*, `--contact-id` *(required)*, `--body`, `--body-file` | -| `delete` | `--org-id` *(required)*, `--contact-id` *(required)* | +| `get` | `--contact-id` *(required)* | +| `list` | `--keyword`, `--source`, `--limit`, `--group-ids` | +| `create` | `--body`, `--body-file` | +| `bulk-create-update` | `--body`, `--body-file` | +| `bulk-delete` | `--schemas`, `--object-ids`, `--body`, `--body-file` | +| `update` | `--contact-id` *(required)*, `--body`, `--body-file` | +| `delete` | `--contact-id` *(required)* | ### organizations | Command | Flags | |---|---| | `list` | — | -| `get` | `--org-id` *(required)* | -| `delete` | `--org-id` *(required)* | +| `get` | — | +| `delete` | — | ### partner-administrators | Command | Flags | |---|---| | `get-all-customers-managed-admin` | `--managed-by` | -| `get-all-admins-assigned-customer` | `--org-id` *(required)* | -| `assign-admin-customer` | `--org-id` *(required)*, `--person-id` *(required)* | -| `unassign-admin-customer` | `--org-id` *(required)*, `--person-id` *(required)* | +| `get-all-admins-assigned-customer` | — | +| `assign-admin-customer` | `--person-id` *(required)* | +| `unassign-admin-customer` | `--person-id` *(required)* | | `revoke-all-admin-roles-person-id` | `--person-id` *(required)* | ### partner-reports-templates @@ -497,31 +504,31 @@ webex admin service-apps get --service-app-id | Command | Flags | |---|---| -| `user-api` | `--org-id` *(required)*, `--body`, `--body-file` | +| `user-api` | `--body`, `--body-file` | ### scim-2-groups | Command | Flags | |---|---| -| `search` | `--org-id` *(required)*, `--filter`, `--attributes`, `--excluded-attributes`, `--sort-by`, `--sort-order`, `--start-index`, `--count`, `--include-members`, `--member-type` | -| `get` | `--org-id` *(required)*, `--group-id` *(required)*, `--excluded-attributes` | -| `get-members` | `--org-id` *(required)*, `--group-id` *(required)*, `--start-index`, `--count`, `--member-type` | -| `create` | `--org-id` *(required)*, `--body`, `--body-file` | -| `update-put` | `--org-id` *(required)*, `--group-id` *(required)*, `--body`, `--body-file` | -| `update-patch` | `--org-id` *(required)*, `--group-id` *(required)*, `--body`, `--body-file` | -| `delete` | `--org-id` *(required)*, `--group-id` *(required)* | +| `search` | `--filter`, `--attributes`, `--excluded-attributes`, `--sort-by`, `--sort-order`, `--start-index`, `--count`, `--include-members`, `--member-type` | +| `get` | `--group-id` *(required)*, `--excluded-attributes` | +| `get-members` | `--group-id` *(required)*, `--start-index`, `--count`, `--member-type` | +| `create` | `--body`, `--body-file` | +| `update-put` | `--group-id` *(required)*, `--body`, `--body-file` | +| `update-patch` | `--group-id` *(required)*, `--body`, `--body-file` | +| `delete` | `--group-id` *(required)* | ### scim-2-users | Command | Flags | |---|---| -| `search` | `--org-id` *(required)*, `--filter`, `--attributes`, `--excluded-attributes`, `--sort-by`, `--sort-order`, `--start-index`, `--count`, `--return-groups`, `--include-group-details`, `--group-usage-types` | -| `get` | `--org-id` *(required)*, `--user-id` *(required)* | +| `search` | `--filter`, `--attributes`, `--excluded-attributes`, `--sort-by`, `--sort-order`, `--start-index`, `--count`, `--return-groups`, `--include-group-details`, `--group-usage-types` | +| `get` | `--user-id` *(required)* | | `get-me` | — | -| `create` | `--org-id` *(required)*, `--body`, `--body-file` | -| `update-put` | `--org-id` *(required)*, `--user-id` *(required)*, `--body`, `--body-file` | -| `update-patch` | `--org-id` *(required)*, `--user-id` *(required)*, `--body`, `--body-file` | -| `delete` | `--org-id` *(required)*, `--user-id` *(required)* | +| `create` | `--body`, `--body-file` | +| `update-put` | `--user-id` *(required)*, `--body`, `--body-file` | +| `update-patch` | `--user-id` *(required)*, `--body`, `--body-file` | +| `delete` | `--user-id` *(required)* | ### security-audit @@ -533,20 +540,20 @@ webex admin service-apps get --service-app-id | Command | Flags | |---|---| -| `get-org` | `--org-id` *(required)*, `--setting-key` *(required)* | -| `create-update-org` | `--org-id` *(required)*, `--key`, `--value`, `--body`, `--body-file` | +| `get-org` | `--setting-key` *(required)* | +| `create-update-org` | `--key`, `--value`, `--body`, `--body-file` | ### partner-tags | Command | Flags | |---|---| | `get-all-customer` | `--type` | -| `get-customer-org` | `--org-id` *(required)* | +| `get-customer-org` | — | | `get-all-customers-set` | `--tags`, `--max` | | `subscription-list-name-set` | `--tags`, `--max` | -| `get-subscription` | `--org-id` *(required)*, `--subscription-id` *(required)* | -| `create-replace-customer-provided-ones` | `--org-id` *(required)*, `--body`, `--body-file` | -| `create-replace-subscription-provided-ones` | `--org-id` *(required)*, `--subscription-id` *(required)*, `--body`, `--body-file` | +| `get-subscription` | `--subscription-id` *(required)* | +| `create-replace-customer-provided-ones` | `--body`, `--body-file` | +| `create-replace-subscription-provided-ones` | `--subscription-id` *(required)*, `--body`, `--body-file` | ### workspace-locations @@ -582,9 +589,9 @@ webex admin service-apps get --service-app-id | Command | Flags | |---|---| -| `get-bulk-resend-job-status` | `--org-id` *(required)*, `--job-id` *(required)* | -| `get-bulk-resend-job-errors` | `--org-id` *(required)*, `--job-id` *(required)*, `--max` | -| `initiate-bulk-resend-job` | `--org-id` *(required)* | +| `get-bulk-resend-job-status` | `--job-id` *(required)* | +| `get-bulk-resend-job-errors` | `--job-id` *(required)*, `--max` | +| `initiate-bulk-resend-job` | — | ### service-apps @@ -602,13 +609,7 @@ webex admin service-apps get --service-app-id | Command | Flags | |---|---| -| `get` | `--org-id` *(required)*, `--useruuid` *(required)* | -| `query` | `--org-id` *(required)*, `--filter` | - -### calling-metrics - -| Command | Flags | -|---|---| -| `webex-call-quality-stats` | `--from`, `--to`, `--location`, `--last` | +| `get` | `--useruuid` *(required)* | +| `query` | `--filter` | diff --git a/skill/calling/SKILL.md b/skill/calling/SKILL.md index a1b8f2c..f702ee0 100644 --- a/skill/calling/SKILL.md +++ b/skill/calling/SKILL.md @@ -228,10 +228,23 @@ webex calling call-settings-for-me upload-voicemail-no-answer-greeting --file gr 5. **`--paginate` on people list** — with `--calling-data=true`, max per page is capped at 100 by the API. Use `--paginate` to traverse large directories. +## Personal call controls and quality metrics + +Use `webex calling call-controls-for-me` for `/members/me/` operations: `dial`, `answer`, `hangup`, `list`, and `get`. Existing `call-controls` operations retain their separate routes. + +```bash +webex calling call-controls-for-me list +webex calling call-controls-for-me get --call-id +webex calling metrics get-call-quality-stats --help +``` + +`metrics get-call-quality-stats` queries the analytics host for aggregated call/media quality. It requires Pro Pack, analytics permissions, and an administrator role. Each query covers up to seven days within the previous three weeks. This operation is grouped under Calling even though its upstream collection is Admin. + ## Command Reference > Auto-generated from Postman collections. Run `make codegen` to update. +> Organization defaults to the authenticated account; use `--organization` to override. ### dect-devices @@ -270,8 +283,6 @@ webex calling call-settings-for-me upload-voicemail-no-answer-greeting --file gr | `list-history` | `--type` | | `list-member-id` | `--member-id` *(required)*, `--org-id` | | `get-member-id` | `--member-id` *(required)*, `--call-id` *(required)*, `--org-id` | -| `list-2` | `--line-owner-id` | -| `get-3` | `--call-id` *(required)*, `--line-owner-id` | | `dial` | `--destination`, `--endpoint-id`, `--single-number-reach-phone-number`, `--line-owner-id`, `--body`, `--body-file` | | `answer` | `--call-id`, `--endpoint-id`, `--line-owner-id`, `--body`, `--body-file` | | `reject` | `--call-id`, `--action`, `--line-owner-id`, `--body`, `--body-file` | @@ -296,9 +307,16 @@ webex calling call-settings-for-me upload-voicemail-no-answer-greeting --file gr | `answer-member-id` | `--member-id` *(required)*, `--org-id`, `--call-id`, `--endpoint-id`, `--body`, `--body-file` | | `hangup-member-id` | `--member-id` *(required)*, `--org-id`, `--call-id`, `--body`, `--body-file` | | `pull` | `--endpoint-id`, `--line-owner-id`, `--body`, `--body-file` | -| `dial-2` | `--destination`, `--endpoint-id`, `--single-number-reach-phone-number`, `--line-owner-id`, `--body`, `--body-file` | -| `answer-2` | `--call-id`, `--endpoint-id`, `--line-owner-id`, `--body`, `--body-file` | -| `hangup-2` | `--call-id`, `--line-owner-id`, `--body`, `--body-file` | + +### call-controls-for-me + +| Command | Flags | +|---|---| +| `list` | `--line-owner-id` | +| `get` | `--call-id` *(required)*, `--line-owner-id` | +| `dial` | `--destination`, `--endpoint-id`, `--single-number-reach-phone-number`, `--line-owner-id`, `--body`, `--body-file` | +| `answer` | `--call-id`, `--endpoint-id`, `--line-owner-id`, `--body`, `--body-file` | +| `hangup` | `--call-id`, `--line-owner-id`, `--body`, `--body-file` | ### call-routing @@ -1167,9 +1185,9 @@ webex calling call-settings-for-me upload-voicemail-no-answer-greeting --file gr | Command | Flags | |---|---| -| `get-bulk-resend-job-status` | `--org-id` *(required)*, `--job-id` *(required)* | -| `get-bulk-resend-job-errors` | `--org-id` *(required)*, `--job-id` *(required)*, `--max` | -| `initiate-bulk-resend-job` | `--org-id` *(required)* | +| `get-bulk-resend-job-status` | `--job-id` *(required)* | +| `get-bulk-resend-job-errors` | `--job-id` *(required)*, `--max` | +| `initiate-bulk-resend-job` | — | ### user-call @@ -1563,4 +1581,10 @@ webex calling call-settings-for-me upload-voicemail-no-answer-greeting --file gr | `update-screen-pop-configuration` | `--location-id` *(required)*, `--queue-id` *(required)*, `--org-id`, `--body`, `--body-file` | | `delete-wrap-up-reason` | `--wrapup-reason-id` *(required)* | +### metrics + +| Command | Flags | +|---|---| +| `get-call-quality-stats` | `--from`, `--to`, `--location`, `--last` | + diff --git a/skill/cc/SKILL.md b/skill/cc/SKILL.md index a3d564d..605724a 100644 --- a/skill/cc/SKILL.md +++ b/skill/cc/SKILL.md @@ -138,23 +138,53 @@ webex cc agents get-statistics --last 8h --interval 15 [--agent-ids ] webex cc agents buddy-list --body '{"agentProfileId":"","mediaType":"telephony","state":"AVAILABLE"}' ``` -## Flows +## Flow authoring and migration + +Current flow commands use the unprefixed Contact Center routes. `flow` is the canonical group; `flows` is an alias. Import/export now use the typed FlowV2 JSON contract, not legacy FDL. Existing automation consuming raw FDL must use `export-legacy` instead. ```bash -# List flows -webex cc flow list [--partial-name-search ] [--flow-type FLOW|SUBFLOW] [--page ] [--size ] +webex cc flow list +webex cc flow get --flow-id +webex cc flow export --flow-id --version draft > flow.json +webex cc flow validate --body-file flow.json +webex cc flow import --body-file flow.json --overwrite false --flow-type FLOW +webex cc flow patch-draft --flow-id --body-file patch.json +webex cc flow export-legacy --flow-id > legacy-flow.json +webex cc activities list-definitions +webex cc events list-specifications +webex cc templates list-flow +``` + +Bodies must be supplied with `--body` or `--body-file`; these generated commands do not read stdin. The CLI uses the fixed project ID internally. `--organization` overrides the login organization. + +Cloverhound checks verified reads and an unpublished disposable draft's import, lock/unlock, patch, save, export, and deletion across both URL forms. The draft was deleted and both routes returned 404 afterward. Publish was not live-tested. Templates use `/templates`; the scoped prefixed template list returned 404. -# Export (download flow JSON) -webex cc flow export --flow-id [--version draft|latest|] > flow.json +**Import limitations:** `flow import-legacy` and `functions import` are exposed but their generated commands do not implement the required upload body. Do not use them for migration until upload handling is implemented. Current `flow import --body-file` was live-tested successfully. -# Import (upload flow JSON) -webex cc flow import --overwrite yes [--flow-type FLOW] -# Note: import reads the body from stdin or --body-file +## Other refreshed Contact Center APIs -# Publish a flow -webex cc flow publish --flow-id --body '{"comment":"Promoting to live"}' +| Group | Purpose | +| --- | --- | +| `activities`, `events`, `templates` | Discover activity schemas, event schemas, input choices, and starter flows. | +| `functions` | Manage custom function source, drafts, locks, versions, and publish tags. `test` implicitly publishes the draft before execution. | +| `asset`, `channel` | Configure work-item/custom-messaging resources and their references. | +| `campaign-group` | List campaigns belonging to a campaign group. | +| `search-metadata` | Discover supported Search GraphQL fields and operations. | +| `usage-reports` | Discover resource types, request asynchronous CSV exports, inspect status, and download files. | +| `external-data-updates` | Update numeric global-variable values on tasks completed within the preceding two days. | + +```bash +webex cc usage-reports list-resource-types +webex cc usage-reports create --body-file report-request.json +webex cc usage-reports get --report-id +webex cc usage-reports download-file --file-id --output raw > report.bin +webex cc external-data-updates update-task-global-variables --body-file task-update.json ``` +Discover report types before creating a report; the collection does not enumerate the types or CSV columns. Download with `fileId`, not `reportId`. Reports can span available data up to 36 months, may split into monthly files, and expire seven days after completion. Only one report processes per organization at a time. + +For task controls, `unhold` (alias `resume`) resumes a held voice call; `pause-digital` and `resume-digital` handle paused non-real-time digital tasks. `append-message` retains `update-2` as an alias. Queue lookups use `list-agent-based`, `list-skill-based`, `list-team-based`, `list-by-skill-profile`, `list-by-dynamic-skills`, and `list-by-user-skill-profile`; pass IDs as flags. Whisper coaching is beta. The refresh also adds conference-participant removal, campaign-time lookup, and contact closure across a campaign chain. + ## Audio Files ```bash @@ -238,388 +268,390 @@ webex cc address-book delete-entry-id --id ## Command Reference > Auto-generated from Postman collections. Run `make codegen` to update. +> Organization defaults to the authenticated account; use `--organization` to override. +> The flow project ID is fixed internally; no project flag is needed. ### agent-wellbeing | Command | Flags | |---|---| -| `get-burnout-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-burnout` | `--orgid` *(required)*, `--filter`, `--attributes`, `--page`, `--page-size` | +| `get-burnout-id` | `--id` *(required)* | +| `list-burnout` | `--filter`, `--attributes`, `--page`, `--page-size` | | `subscribe-realtime-burnout-events` | `--destination-url`, `--event-types`, `--name`, `--description`, `--secret`, `--org-id`, `--body`, `--body-file` | | `record-realtime-burnout-events` | `--body`, `--body-file` | -| `update-burnout-id` | `--orgid` *(required)*, `--id` *(required)*, `--agent-inclusion-type`, `--enabled`, `--organization-id`, `--version`, `--wellness-break-reminders`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `update-burnout-id` | `--id` *(required)*, `--agent-inclusion-type`, `--enabled`, `--organization-id`, `--version`, `--wellness-break-reminders`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | ### auto-csat | Command | Flags | |---|---| -| `get-mapped-question-id` | `--orgid` *(required)*, `--auto-csat-id` *(required)*, `--id` *(required)* | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--page`, `--page-size` | -| `list-mapped-question` | `--orgid` *(required)*, `--auto-csat-id` *(required)*, `--filter`, `--attributes`, `--page`, `--page-size` | -| `create-mapped-question` | `--orgid` *(required)*, `--auto-csat-id` *(required)*, `--question-id`, `--questionnaire-id`, `--organization-id`, `--id`, `--version`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `bulk-save-mapped-question` | `--orgid` *(required)*, `--auto-csat-id` *(required)*, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--agent-inclusion-type`, `--enabled`, `--selected-global-variable-id`, `--survey-data-source`, `--organization-id`, `--version`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `delete-mapped-question-id` | `--orgid` *(required)*, `--auto-csat-id` *(required)*, `--id` *(required)* | +| `get-mapped-question-id` | `--auto-csat-id` *(required)*, `--id` *(required)* | +| `get-id` | `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--page`, `--page-size` | +| `list-mapped-question` | `--auto-csat-id` *(required)*, `--filter`, `--attributes`, `--page`, `--page-size` | +| `create-mapped-question` | `--auto-csat-id` *(required)*, `--question-id`, `--questionnaire-id`, `--organization-id`, `--id`, `--version`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `bulk-save-mapped-question` | `--auto-csat-id` *(required)*, `--body`, `--body-file` | +| `update-id` | `--id` *(required)*, `--agent-inclusion-type`, `--enabled`, `--selected-global-variable-id`, `--survey-data-source`, `--organization-id`, `--version`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `delete-mapped-question-id` | `--auto-csat-id` *(required)*, `--id` *(required)* | ### generated-summaries | Command | Flags | |---|---| -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--page`, `--page-size` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--organization-id`, `--version`, `--call-drop-summaries-enabled`, `--virtual-agent-transfer-summaries-enabled`, `--consult-transfer-summaries-enabled`, `--agent-inclusion-type`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `get-id` | `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--page`, `--page-size` | +| `update-id` | `--id` *(required)*, `--organization-id`, `--version`, `--call-drop-summaries-enabled`, `--virtual-agent-transfer-summaries-enabled`, `--consult-transfer-summaries-enabled`, `--agent-inclusion-type`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | ### business-hour | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-count`, `--single-object-response` | -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-count`, `--single-object-response` | +| `bulk-export` | `--page`, `--page-size` | +| `get-id` | `--id` *(required)* | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `create` | `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### holiday-list | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-count`, `--single-object-response` | -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-count`, `--single-object-response` | +| `bulk-export` | `--page`, `--page-size` | +| `get-id` | `--id` *(required)* | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `create` | `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### overrides | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-latest-override`, `--single-object-response` | -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-latest-override`, `--single-object-response` | +| `bulk-export` | `--page`, `--page-size` | +| `get-id` | `--id` *(required)* | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `create` | `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### address-book | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-entry-id` | `--orgid` *(required)*, `--address-book-id` *(required)*, `--id` *(required)* | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `list-entry` | `--orgid` *(required)*, `--address-book-id` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--name`, `--parent-type`, `--organization-id`, `--id`, `--version`, `--description`, `--site-id`, `--body`, `--body-file` | -| `create-entry` | `--orgid` *(required)*, `--address-book-id` *(required)*, `--name`, `--number`, `--organization-id`, `--id`, `--version`, `--body`, `--body-file` | -| `bulk-save-entry` | `--orgid` *(required)*, `--address-book-id` *(required)*, `--body`, `--body-file` | -| `update-entry-id` | `--orgid` *(required)*, `--address-book-id` *(required)*, `--id` *(required)*, `--name`, `--number`, `--organization-id`, `--version`, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--name`, `--parent-type`, `--organization-id`, `--version`, `--description`, `--site-id`, `--body`, `--body-file` | -| `delete-entry-id` | `--orgid` *(required)*, `--address-book-id` *(required)*, `--id` *(required)* | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | +| `bulk-export` | `--page`, `--page-size` | +| `get-entry-id` | `--address-book-id` *(required)*, `--id` *(required)* | +| `get-id` | `--id` *(required)* | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `list-entry` | `--address-book-id` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | +| `create` | `--name`, `--parent-type`, `--organization-id`, `--id`, `--version`, `--description`, `--site-id`, `--body`, `--body-file` | +| `create-entry` | `--address-book-id` *(required)*, `--name`, `--number`, `--organization-id`, `--id`, `--version`, `--body`, `--body-file` | +| `bulk-save-entry` | `--address-book-id` *(required)*, `--body`, `--body-file` | +| `update-entry-id` | `--address-book-id` *(required)*, `--id` *(required)*, `--name`, `--number`, `--organization-id`, `--version`, `--body`, `--body-file` | +| `update-id` | `--id` *(required)*, `--name`, `--parent-type`, `--organization-id`, `--version`, `--description`, `--site-id`, `--body`, `--body-file` | +| `delete-entry-id` | `--address-book-id` *(required)*, `--id` *(required)* | +| `delete-id` | `--id` *(required)* | ### audio-files | Command | Flags | |---|---| -| `get-id` | `--orgid` *(required)*, `--id` *(required)*, `--include-url` | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `patch-id` | `--orgid` *(required)*, `--id` *(required)*, `--description`, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `get-id` | `--id` *(required)*, `--include-url` | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | +| `create` | `--body`, `--body-file` | +| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `patch-id` | `--id` *(required)*, `--description`, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### auxiliary-code | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--desktop-profile-filter`, `--supervised-user-id` | -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--active`, `--default-code`, `--name`, `--work-type-code`, `--work-type-id`, `--organization-id`, `--id`, `--version`, `--description`, `--is-system-code`, `--burnout-inclusion`, `--system-default`, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `purge-inactive` | `--orgid` *(required)*, `--next-start-id` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--active`, `--default-code`, `--name`, `--work-type-code`, `--work-type-id`, `--organization-id`, `--version`, `--description`, `--is-system-code`, `--burnout-inclusion`, `--system-default`, `--body`, `--body-file` | -| `bulk-partial-update` | `--orgid` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--desktop-profile-filter`, `--supervised-user-id` | +| `bulk-export` | `--page`, `--page-size` | +| `get-id` | `--id` *(required)* | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `create` | `--active`, `--default-code`, `--name`, `--work-type-code`, `--work-type-id`, `--organization-id`, `--id`, `--version`, `--description`, `--is-system-code`, `--burnout-inclusion`, `--system-default`, `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `purge-inactive` | `--next-start-id` | +| `update-id` | `--id` *(required)*, `--active`, `--default-code`, `--name`, `--work-type-code`, `--work-type-id`, `--organization-id`, `--version`, `--description`, `--is-system-code`, `--burnout-inclusion`, `--system-default`, `--body`, `--body-file` | +| `bulk-partial-update` | `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### contact-number | Command | Flags | |---|---| -| `list-all` | `--orgid` *(required)* | -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--number`, `--organization-id`, `--id`, `--version`, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--number`, `--organization-id`, `--version`, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list-all` | — | +| `bulk-export` | `--page`, `--page-size` | +| `get-id` | `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | +| `create` | `--number`, `--organization-id`, `--id`, `--version`, `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `update-id` | `--id` *(required)*, `--number`, `--organization-id`, `--version`, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### contact-service-queue | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--desktop-profile-filter`, `--provisioning-view`, `--single-object-response` | -| `bulk-export` | `--orgid` *(required)*, `--type`, `--page`, `--page-size` | -| `list-skill-based-skill-profile-id` | `--orgid` *(required)*, `--id` *(required)* | -| `get-id` | `--orgid` *(required)*, `--id` *(required)*, `--agents-updated-info` | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `list-agent-based-user-id` | `--orgid` *(required)*, `--userid` *(required)*, `--search`, `--page`, `--page-size` | -| `list-skill-based-user-id` | `--orgid` *(required)*, `--userid` *(required)*, `--search`, `--page`, `--page-size` | -| `list-team-based-user-id` | `--orgid` *(required)*, `--userid` *(required)*, `--search`, `--page`, `--page-size` | -| `list-internal-skill-csqs-profile` | `--orgid` *(required)*, `--id` *(required)* | -| `list-team-csqs-team-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-agent-csqs-ci-user-id` | `--orgid` *(required)*, `--ci-user-id` *(required)* | -| `list-skill-csqs-ci-user-id` | `--orgid` *(required)*, `--id` *(required)* | -| `create` | `--orgid` *(required)*, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `delete-references` | `--orgid` *(required)*, `--body`, `--body-file` | -| `list-manually-assignable` | `--orgid` *(required)*, `--agent-id`, `--team-id`, `--body`, `--body-file` | -| `purge-inactive` | `--orgid` *(required)*, `--next-start-id` | -| `create-remove-agents-users-agent` | `--orgid` *(required)*, `--id` *(required)*, `--add`, `--remove`, `--body`, `--body-file` | -| `list-mapping-summary-grouped-assistant-skill` | `--orgid` *(required)*, `--page`, `--page-size`, `--assistant-skill-ids`, `--body`, `--body-file` | -| `list-skill-based-dynamic-skills-skill-profile` | `--orgid` *(required)*, `--body`, `--body-file` | -| `list-skill-based-skill-profile-id-user-id` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `bulk-partial-update` | `--orgid` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--desktop-profile-filter`, `--provisioning-view`, `--single-object-response` | +| `bulk-export` | `--type`, `--page`, `--page-size` | +| `list-by-skill-profile` (aliases: `list-skill-csqs-skill-profile`) | `--id` *(required)* | +| `get-id` | `--id` *(required)*, `--agents-updated-info` | +| `list-references` (aliases: `list-csq-references-id`) | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `list-agent-based` | `--userid` *(required)*, `--search`, `--page`, `--page-size` | +| `list-skill-based` | `--userid` *(required)*, `--search`, `--page`, `--page-size` | +| `list-team-based` | `--userid` *(required)*, `--search`, `--page`, `--page-size` | +| `list-internal-skill-csqs-profile` | `--id` *(required)* | +| `list-team-csqs-team-id` | `--id` *(required)* | +| `list-agent-csqs-ci-user-id` | `--ci-user-id` *(required)* | +| `list-skill-csqs-ci-user-id` | `--id` *(required)* | +| `create` | `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `delete-references` (aliases: `delete-csq-references`) | `--body`, `--body-file` | +| `list-manually-assignable` (aliases: `list-manually-assignable-csqs`) | `--agent-id`, `--team-id`, `--body`, `--body-file` | +| `purge-inactive` | `--next-start-id` | +| `create-remove-agents-users-agent` | `--id` *(required)*, `--add`, `--remove`, `--body`, `--body-file` | +| `list-mapping-summary-grouped-assistant-skill` | `--page`, `--page-size`, `--assistant-skill-ids`, `--body`, `--body-file` | +| `list-by-dynamic-skills` (aliases: `list-csqs-skills-profile`) | `--body`, `--body-file` | +| `list-by-user-skill-profile` (aliases: `list-csqs-user-profile`) | `--body`, `--body-file` | +| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `bulk-partial-update` | `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### desktop-layout | Command | Flags | |---|---| -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response`, `--provisioning-view` | -| `create` | `--orgid` *(required)*, `--default-json-modified`, `--edited-by`, `--global`, `--json-file-content`, `--json-file-name`, `--name`, `--status`, `--validated`, `--organization-id`, `--id`, `--version`, `--description`, `--validated-time`, `--default-json-modified-time`, `--modified-time`, `--team-ids`, `--system-default`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `purge-inactive` | `--orgid` *(required)*, `--next-start-id` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--default-json-modified`, `--edited-by`, `--global`, `--json-file-content`, `--json-file-name`, `--name`, `--status`, `--validated`, `--organization-id`, `--version`, `--description`, `--validated-time`, `--default-json-modified-time`, `--modified-time`, `--team-ids`, `--system-default`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `bulk-export` | `--page`, `--page-size` | +| `get-id` | `--id` *(required)* | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response`, `--provisioning-view` | +| `create` | `--default-json-modified`, `--edited-by`, `--global`, `--json-file-content`, `--json-file-name`, `--name`, `--status`, `--validated`, `--organization-id`, `--id`, `--version`, `--description`, `--validated-time`, `--default-json-modified-time`, `--modified-time`, `--team-ids`, `--system-default`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `purge-inactive` | `--next-start-id` | +| `update-id` | `--id` *(required)*, `--default-json-modified`, `--edited-by`, `--global`, `--json-file-content`, `--json-file-name`, `--name`, `--status`, `--validated`, `--organization-id`, `--version`, `--description`, `--validated-time`, `--default-json-modified-time`, `--modified-time`, `--team-ids`, `--system-default`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### desktop-profile | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response`, `--provisioning-view` | -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--access-buddy-team`, `--access-entry-point`, `--access-idle-code`, `--access-queue`, `--access-wrap-up-code`, `--active`, `--agent-dnvalidation`, `--name`, `--parent-type`, `--viewable-statistics`, `--organization-id`, `--id`, `--version`, `--description`, `--site-id`, `--screen-popup`, `--last-agent-routing`, `--schedule-and-manage-call-back`, `--auto-wrap-up`, `--auto-answer`, `--agent-personal-greeting`, `--auto-wrap-after-seconds`, `--agent-available-after-outdial`, `--allow-auto-wrap-up-extension`, `--wrap-up-codes`, `--idle-codes`, `--queues`, `--entry-points`, `--buddy-teams`, `--consult-to-queue`, `--outdial-enabled`, `--outdial-entry-point-id`, `--outdial-aniid`, `--address-book-id`, `--dial-plan-enabled`, `--dial-plans`, `--agent-dnvalidation-criteria`, `--agent-dnvalidation-criterions`, `--login-voice-options`, `--threshold-rules`, `--timeout-desktop-inactivity-custom-enabled`, `--show-user-details-ms`, `--state-synchronization-ms`, `--show-user-details-webex`, `--state-synchronization-webex`, `--manage-channel-availability`, `--timeout-desktop-inactivity-mins`, `--system-default`, `--created-time`, `--last-updated-time`, `--auto-accept-digital-interactions`, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `purge-inactive` | `--orgid` *(required)*, `--next-start-id` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--access-buddy-team`, `--access-entry-point`, `--access-idle-code`, `--access-queue`, `--access-wrap-up-code`, `--active`, `--agent-dnvalidation`, `--name`, `--parent-type`, `--viewable-statistics`, `--organization-id`, `--version`, `--description`, `--site-id`, `--screen-popup`, `--last-agent-routing`, `--schedule-and-manage-call-back`, `--auto-wrap-up`, `--auto-answer`, `--agent-personal-greeting`, `--auto-wrap-after-seconds`, `--agent-available-after-outdial`, `--allow-auto-wrap-up-extension`, `--wrap-up-codes`, `--idle-codes`, `--queues`, `--entry-points`, `--buddy-teams`, `--consult-to-queue`, `--outdial-enabled`, `--outdial-entry-point-id`, `--outdial-aniid`, `--address-book-id`, `--dial-plan-enabled`, `--dial-plans`, `--agent-dnvalidation-criteria`, `--agent-dnvalidation-criterions`, `--login-voice-options`, `--threshold-rules`, `--timeout-desktop-inactivity-custom-enabled`, `--show-user-details-ms`, `--state-synchronization-ms`, `--show-user-details-webex`, `--state-synchronization-webex`, `--manage-channel-availability`, `--timeout-desktop-inactivity-mins`, `--system-default`, `--created-time`, `--last-updated-time`, `--auto-accept-digital-interactions`, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response`, `--provisioning-view` | +| `bulk-export` | `--page`, `--page-size` | +| `get-id` | `--id` *(required)* | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `create` | `--access-buddy-team`, `--access-entry-point`, `--access-idle-code`, `--access-queue`, `--access-wrap-up-code`, `--active`, `--agent-dnvalidation`, `--name`, `--parent-type`, `--viewable-statistics`, `--organization-id`, `--id`, `--version`, `--description`, `--site-id`, `--screen-popup`, `--last-agent-routing`, `--schedule-and-manage-call-back`, `--auto-wrap-up`, `--auto-answer`, `--agent-personal-greeting`, `--auto-wrap-after-seconds`, `--agent-available-after-outdial`, `--allow-auto-wrap-up-extension`, `--wrap-up-codes`, `--idle-codes`, `--queues`, `--entry-points`, `--buddy-teams`, `--consult-to-queue`, `--outdial-enabled`, `--outdial-entry-point-id`, `--outdial-aniid`, `--address-book-id`, `--dial-plan-enabled`, `--dial-plans`, `--agent-dnvalidation-criteria`, `--agent-dnvalidation-criterions`, `--login-voice-options`, `--threshold-rules`, `--timeout-desktop-inactivity-custom-enabled`, `--show-user-details-ms`, `--state-synchronization-ms`, `--show-user-details-webex`, `--state-synchronization-webex`, `--manage-channel-availability`, `--timeout-desktop-inactivity-mins`, `--system-default`, `--created-time`, `--last-updated-time`, `--auto-accept-digital-interactions`, `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `purge-inactive` | `--next-start-id` | +| `update-id` | `--id` *(required)*, `--access-buddy-team`, `--access-entry-point`, `--access-idle-code`, `--access-queue`, `--access-wrap-up-code`, `--active`, `--agent-dnvalidation`, `--name`, `--parent-type`, `--viewable-statistics`, `--organization-id`, `--version`, `--description`, `--site-id`, `--screen-popup`, `--last-agent-routing`, `--schedule-and-manage-call-back`, `--auto-wrap-up`, `--auto-answer`, `--agent-personal-greeting`, `--auto-wrap-after-seconds`, `--agent-available-after-outdial`, `--allow-auto-wrap-up-extension`, `--wrap-up-codes`, `--idle-codes`, `--queues`, `--entry-points`, `--buddy-teams`, `--consult-to-queue`, `--outdial-enabled`, `--outdial-entry-point-id`, `--outdial-aniid`, `--address-book-id`, `--dial-plan-enabled`, `--dial-plans`, `--agent-dnvalidation-criteria`, `--agent-dnvalidation-criterions`, `--login-voice-options`, `--threshold-rules`, `--timeout-desktop-inactivity-custom-enabled`, `--show-user-details-ms`, `--state-synchronization-ms`, `--show-user-details-webex`, `--state-synchronization-webex`, `--manage-channel-availability`, `--timeout-desktop-inactivity-mins`, `--system-default`, `--created-time`, `--last-updated-time`, `--auto-accept-digital-interactions`, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### dial-number | Command | Flags | |---|---| -| `list-dialed-mapping` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--include-entry-point-name` | -| `bulk-export-dialed-mapping` | `--orgid` *(required)*, `--page`, `--page-size` | -| `list-dialed-dialed-mapping` | `--orgid` *(required)* | -| `get-dialed-mapping-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references-dialed-mapping` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `create-dialed-mapping` | `--orgid` *(required)*, `--entry-point-id`, `--entry-point-name`, `--organization-id`, `--id`, `--version`, `--dialled-number`, `--extension`, `--routing-prefix`, `--esn`, `--route-point-id`, `--default-ani`, `--location`, `--region-id`, `--created-time`, `--last-updated-time`, `--dialled-number-digits`, `--body`, `--body-file` | -| `bulk-save-dialed-mapping` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-dialed-mapping-id` | `--orgid` *(required)*, `--id` *(required)*, `--entry-point-id`, `--entry-point-name`, `--organization-id`, `--version`, `--dialled-number`, `--extension`, `--routing-prefix`, `--esn`, `--route-point-id`, `--default-ani`, `--location`, `--region-id`, `--created-time`, `--last-updated-time`, `--dialled-number-digits`, `--body`, `--body-file` | -| `delete-all-dialed-mapping` | `--orgid` *(required)* | -| `delete-dialed-mapping-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list-dialed-mapping` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--include-entry-point-name` | +| `bulk-export-dialed-mapping` | `--page`, `--page-size` | +| `list-dialed-dialed-mapping` | — | +| `get-dialed-mapping-id` | `--id` *(required)* | +| `list-references-dialed-mapping` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `create-dialed-mapping` | `--entry-point-id`, `--entry-point-name`, `--organization-id`, `--id`, `--version`, `--dialled-number`, `--extension`, `--routing-prefix`, `--esn`, `--route-point-id`, `--default-ani`, `--location`, `--region-id`, `--created-time`, `--last-updated-time`, `--dialled-number-digits`, `--body`, `--body-file` | +| `bulk-save-dialed-mapping` | `--body`, `--body-file` | +| `update-dialed-mapping-id` | `--id` *(required)*, `--entry-point-id`, `--entry-point-name`, `--organization-id`, `--version`, `--dialled-number`, `--extension`, `--routing-prefix`, `--esn`, `--route-point-id`, `--default-ani`, `--location`, `--region-id`, `--created-time`, `--last-updated-time`, `--dialled-number-digits`, `--body`, `--body-file` | +| `delete-all-dialed-mapping` | — | +| `delete-dialed-mapping-id` | `--id` *(required)* | ### dial-plan | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--active`, `--name`, `--regular-expression`, `--organization-id`, `--id`, `--version`, `--description`, `--prefix`, `--stripped-chars`, `--system-default`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--active`, `--name`, `--regular-expression`, `--organization-id`, `--version`, `--description`, `--prefix`, `--stripped-chars`, `--system-default`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | +| `bulk-export` | `--page`, `--page-size` | +| `get-id` | `--id` *(required)* | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `create` | `--active`, `--name`, `--regular-expression`, `--organization-id`, `--id`, `--version`, `--description`, `--prefix`, `--stripped-chars`, `--system-default`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `update-id` | `--id` *(required)*, `--active`, `--name`, `--regular-expression`, `--organization-id`, `--version`, `--description`, `--prefix`, `--stripped-chars`, `--system-default`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### entry-point | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--desktop-profile-filter`, `--provisioning-view`, `--include-count`, `--single-object-response` | -| `bulk-export` | `--orgid` *(required)*, `--type`, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)*, `--include-names` | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `purge-inactive` | `--orgid` *(required)*, `--next-start-id` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--desktop-profile-filter`, `--provisioning-view`, `--include-count`, `--single-object-response` | +| `bulk-export` | `--type`, `--page`, `--page-size` | +| `get-id` | `--id` *(required)*, `--include-names` | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `create` | `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `purge-inactive` | `--next-start-id` | +| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### global-variables | Command | Flags | |---|---| -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-reportable-count` | `--orgid` *(required)* | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--active`, `--agent-editable`, `--agent-viewable`, `--default-value`, `--name`, `--reportable`, `--variable-type`, `--organization-id`, `--id`, `--version`, `--description`, `--sensitive`, `--desktop-label`, `--system-default`, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `purge-inactive` | `--orgid` *(required)*, `--next-start-id` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--active`, `--agent-editable`, `--agent-viewable`, `--default-value`, `--name`, `--reportable`, `--variable-type`, `--organization-id`, `--version`, `--description`, `--sensitive`, `--desktop-label`, `--system-default`, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `bulk-export` | `--page`, `--page-size` | +| `get-reportable-count` | — | +| `get-id` | `--id` *(required)* | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | +| `create` | `--active`, `--agent-editable`, `--agent-viewable`, `--default-value`, `--name`, `--reportable`, `--variable-type`, `--organization-id`, `--id`, `--version`, `--description`, `--sensitive`, `--desktop-label`, `--system-default`, `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `purge-inactive` | `--next-start-id` | +| `update-id` | `--id` *(required)*, `--active`, `--agent-editable`, `--agent-viewable`, `--default-value`, `--name`, `--reportable`, `--variable-type`, `--organization-id`, `--version`, `--description`, `--sensitive`, `--desktop-label`, `--system-default`, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### multimedia-profile | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `purge-inactive` | `--orgid` *(required)*, `--next-start-id` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | +| `bulk-export` | `--page`, `--page-size` | +| `get-id` | `--id` *(required)* | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `create` | `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `purge-inactive` | `--next-start-id` | +| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### outdial-ani | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response` | -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `list-entries` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `get-entry-id` | `--orgid` *(required)*, `--out-dial-ani-id` *(required)*, `--id` *(required)* | -| `list-entries-2` | `--orgid` *(required)*, `--out-dial-ani-id` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `create-entry` | `--orgid` *(required)*, `--out-dial-ani-id` *(required)*, `--name`, `--number`, `--organization-id`, `--id`, `--version`, `--default-anientry`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `bulk-save-entries` | `--orgid` *(required)*, `--out-dial-ani-id` *(required)*, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `update-entry-id` | `--orgid` *(required)*, `--out-dial-ani-id` *(required)*, `--id` *(required)*, `--name`, `--number`, `--organization-id`, `--version`, `--default-anientry`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | -| `delete-entry-id` | `--orgid` *(required)*, `--out-dial-ani-id` *(required)*, `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response` | +| `bulk-export` | `--page`, `--page-size` | +| `list-entries` (aliases: `list-entry`) | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | +| `get-id` | `--id` *(required)* | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `get-entry-id` | `--out-dial-ani-id` *(required)*, `--id` *(required)* | +| `list-entries-for-ani` (aliases: `list-entry-2`) | `--out-dial-ani-id` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | +| `create` | `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `create-entry` | `--out-dial-ani-id` *(required)*, `--name`, `--number`, `--organization-id`, `--id`, `--version`, `--default-anientry`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `bulk-save-entries` (aliases: `bulk-save-entry`) | `--out-dial-ani-id` *(required)*, `--body`, `--body-file` | +| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `update-entry-id` | `--out-dial-ani-id` *(required)*, `--id` *(required)*, `--name`, `--number`, `--organization-id`, `--version`, `--default-anientry`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | +| `delete-entry-id` | `--out-dial-ani-id` *(required)*, `--id` *(required)* | ### site | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--active`, `--multimedia-profile-id`, `--name`, `--organization-id`, `--id`, `--version`, `--description`, `--system-default`, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `purge-inactive` | `--orgid` *(required)*, `--next-start-id` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--active`, `--multimedia-profile-id`, `--name`, `--organization-id`, `--version`, `--description`, `--system-default`, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | +| `bulk-export` | `--page`, `--page-size` | +| `get-id` | `--id` *(required)* | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `create` | `--active`, `--multimedia-profile-id`, `--name`, `--organization-id`, `--id`, `--version`, `--description`, `--system-default`, `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `purge-inactive` | `--next-start-id` | +| `update-id` | `--id` *(required)*, `--active`, `--multimedia-profile-id`, `--name`, `--organization-id`, `--version`, `--description`, `--system-default`, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### skill | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response`, `--include` | -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `purge-inactive` | `--orgid` *(required)*, `--next-start-id` | -| `populate-json-attributes-field-skill-id-org` | `--orgid` *(required)*, `--id` *(required)* | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response`, `--include` | +| `bulk-export` | `--page`, `--page-size` | +| `get-id` | `--id` *(required)* | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `create` | `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `purge-inactive` | `--next-start-id` | +| `populate-json-attributes-field-skill-id-org` | `--id` *(required)* | +| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### skill-profile | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response` | -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)*, `--include-skill-details` | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--active-skills`, `--name`, `--organization-id`, `--id`, `--version`, `--description`, `--active-enum-skills`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--active-skills`, `--name`, `--organization-id`, `--version`, `--description`, `--active-enum-skills`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response` | +| `bulk-export` | `--page`, `--page-size` | +| `get-id` | `--id` *(required)*, `--include-skill-details` | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `create` | `--active-skills`, `--name`, `--organization-id`, `--id`, `--version`, `--description`, `--active-enum-skills`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `update-id` | `--id` *(required)*, `--active-skills`, `--name`, `--organization-id`, `--version`, `--description`, `--active-enum-skills`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### team | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--supervisor-view`, `--provisioning-view`, `--single-object-response` | -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--active`, `--name`, `--rank-queues-for-team`, `--site-id`, `--team-status`, `--team-type`, `--organization-id`, `--id`, `--version`, `--dialed-number`, `--capacity`, `--desktop-layout-id`, `--skill-profile-id`, `--multi-media-profile-id`, `--user-ids`, `--description`, `--system-default`, `--queue-rankings`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `purge-inactive` | `--orgid` *(required)*, `--next-start-id` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--active`, `--name`, `--rank-queues-for-team`, `--site-id`, `--team-status`, `--team-type`, `--organization-id`, `--version`, `--dialed-number`, `--capacity`, `--desktop-layout-id`, `--skill-profile-id`, `--multi-media-profile-id`, `--user-ids`, `--description`, `--system-default`, `--queue-rankings`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--supervisor-view`, `--provisioning-view`, `--single-object-response` | +| `bulk-export` | `--page`, `--page-size` | +| `get-id` | `--id` *(required)* | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `create` | `--active`, `--name`, `--rank-queues-for-team`, `--site-id`, `--team-status`, `--team-type`, `--organization-id`, `--id`, `--version`, `--dialed-number`, `--capacity`, `--desktop-layout-id`, `--skill-profile-id`, `--multi-media-profile-id`, `--user-ids`, `--description`, `--system-default`, `--queue-rankings`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `purge-inactive` | `--next-start-id` | +| `update-id` | `--id` *(required)*, `--active`, `--name`, `--rank-queues-for-team`, `--site-id`, `--team-status`, `--team-type`, `--organization-id`, `--version`, `--dialed-number`, `--capacity`, `--desktop-layout-id`, `--skill-profile-id`, `--multi-media-profile-id`, `--user-ids`, `--description`, `--system-default`, `--queue-rankings`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### user-profiles | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)*, `--include-names` | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `get-acl-id` | `--orgid` *(required)*, `--id` *(required)*, `--names` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `purge-inactive` | `--orgid` *(required)*, `--next-start-id` | -| `create` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | +| `bulk-export` | `--page`, `--page-size` | +| `get-id` | `--id` *(required)*, `--include-names` | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `get-acl-id` | `--id` *(required)*, `--names` | +| `bulk-save` | `--body`, `--body-file` | +| `purge-inactive` | `--next-start-id` | +| `create` | `--body`, `--body-file` | +| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### users | Command | Flags | |---|---| -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--supervisor-managed-agents-only`, `--single-object-response`, `--buddy-team-agents-only`, `--user-in-queue`, `--queue-id`, `--include-aimapping-count`, `--include-dynamic-skills-limit-reached` | -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-ci-id` | `--orgid` *(required)*, `--id` *(required)*, `--include-user-profile`, `--include-names`, `--include-skill-details` | -| `list-along-profile` | `--orgid` *(required)* | -| `get-along-profile-id` | `--orgid` *(required)*, `--id` *(required)* | -| `get-id` | `--orgid` *(required)*, `--id` *(required)*, `--include-count`, `--include-user-profile-type`, `--include-skill-profile-audit`, `--include-reskill-audit-info`, `--include-skill-details`, `--check-if-user-has-dynamic-skill`, `--dynamic-skill-id` | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `get-dynamic-skill-id` | `--orgid` *(required)*, `--skill-id` *(required)*, `--search`, `--page`, `--page-size` | -| `list-call-monitoring-id` | `--orgid` *(required)*, `--id` *(required)*, `--page`, `--page-size` | -| `get-agents-matching-skill-requirements` | `--orgid` *(required)*, `--search`, `--page`, `--page-size`, `--body`, `--body-file` | -| `list-2` | `--orgid` *(required)*, `--page`, `--page-size`, `--user-ids`, `--search`, `--queue-id`, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `bulk-partial-update` | `--orgid` *(required)*, `--body`, `--body-file` | -| `patch-id` | `--orgid` *(required)*, `--id` *(required)*, `--value-type`, `--body`, `--body-file` | -| `bulk-partial-update-dynamic-skills` | `--orgid` *(required)*, `--skill-id` *(required)*, `--body`, `--body-file` | -| `reskill-agents` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--supervisor-managed-agents-only`, `--single-object-response`, `--buddy-team-agents-only`, `--user-in-queue`, `--queue-id`, `--include-aimapping-count`, `--include-dynamic-skills-limit-reached` | +| `bulk-export` | `--page`, `--page-size` | +| `get-ci-id` | `--id` *(required)*, `--include-user-profile`, `--include-names`, `--include-skill-details` | +| `list-along-profile` | — | +| `get-along-profile-id` | `--id` *(required)* | +| `get-id` | `--id` *(required)*, `--include-count`, `--include-user-profile-type`, `--include-skill-profile-audit`, `--include-reskill-audit-info`, `--include-skill-details`, `--check-if-user-has-dynamic-skill`, `--dynamic-skill-id` | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `get-dynamic-skill-id` | `--skill-id` *(required)*, `--search`, `--page`, `--page-size` | +| `list-call-monitoring-id` | `--id` *(required)*, `--page`, `--page-size` | +| `get-agents-matching-skill-requirements` | `--search`, `--page`, `--page-size`, `--body`, `--body-file` | +| `list-by-ids` (aliases: `get-ids`) | `--page`, `--page-size`, `--user-ids`, `--search`, `--queue-id`, `--body`, `--body-file` | +| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `bulk-partial-update` | `--body`, `--body-file` | +| `patch-id` | `--id` *(required)*, `--value-type`, `--body`, `--body-file` | +| `bulk-partial-update-dynamic-skills` (aliases: `bulk-update-dynamic-skills`) | `--skill-id` *(required)*, `--body`, `--body-file` | +| `reskill-agents` | `--id` *(required)*, `--body`, `--body-file` | ### work-types | Command | Flags | |---|---| -| `bulk-export` | `--orgid` *(required)*, `--page`, `--page-size` | -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--active`, `--name`, `--work-type-code`, `--organization-id`, `--id`, `--version`, `--description`, `--system-default`, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `purge-inactive` | `--orgid` *(required)*, `--next-start-id` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--active`, `--name`, `--work-type-code`, `--organization-id`, `--version`, `--description`, `--system-default`, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `bulk-export` | `--page`, `--page-size` | +| `get-id` | `--id` *(required)* | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | +| `create` | `--active`, `--name`, `--work-type-code`, `--organization-id`, `--id`, `--version`, `--description`, `--system-default`, `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `purge-inactive` | `--next-start-id` | +| `update-id` | `--id` *(required)*, `--active`, `--name`, `--work-type-code`, `--organization-id`, `--version`, `--description`, `--system-default`, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### data-sources @@ -709,7 +741,7 @@ webex cc address-book delete-entry-id --id | `end` | `--task-id` *(required)* | | `wrap-up` | `--task-id` *(required)*, `--wrap-up-reason`, `--aux-code-id`, `--body`, `--body-file` | | `hold` | `--task-id` *(required)*, `--media-resource-id`, `--body`, `--body-file` | -| `unhold` | `--task-id` *(required)*, `--media-resource-id`, `--body`, `--body-file` | +| `unhold` (aliases: `resume`) | `--task-id` *(required)*, `--media-resource-id`, `--body`, `--body-file` | | `reject` | `--task-id` *(required)*, `--media-resource-id`, `--body`, `--body-file` | | `pause-recording` | `--task-id` *(required)* | | `resume-recording` | `--task-id` *(required)*, `--auto-resumed`, `--body`, `--body-file` | @@ -724,10 +756,10 @@ webex cc address-book delete-entry-id --id | `accept-preview` | `--campaign-id` *(required)*, `--task-id` *(required)* | | `skip-preview` | `--campaign-id` *(required)*, `--task-id` *(required)* | | `delete-preview` | `--campaign-id` *(required)*, `--task-id` *(required)* | -| `append-message` | `--task-id` *(required)*, `--body`, `--body-file` | +| `append-message` (aliases: `update-2`) | `--task-id` *(required)*, `--body`, `--body-file` | | `drop-participant-conference` | `--task-id` *(required)*, `--participant-id` *(required)* | -| `pause` | `--task-id` *(required)* | -| `resume` | `--task-id` *(required)* | +| `pause-digital` | `--task-id` *(required)* | +| `resume-digital` | `--task-id` *(required)* | | `update` | `--task-id` *(required)*, `--body`, `--body-file` | ### journey @@ -778,7 +810,7 @@ webex cc address-book delete-entry-id --id | Command | Flags | |---|---| -| `get-valid-times` | `--org-id` *(required)*, `--campaign-id`, `--interaction-id`, `--agent-id`, `--tracking-id` | +| `get-valid-times` | `--campaign-id`, `--interaction-id`, `--agent-id`, `--tracking-id` | | `start-request` | `--body`, `--body-file` | | `update-request` | `--campaign-id` *(required)*, `--body`, `--body-file` | | `stop-request` | `--campaign-id` *(required)* | @@ -791,47 +823,60 @@ webex cc address-book delete-entry-id --id ### flow +Group aliases: `flows`. + | Command | Flags | |---|---| -| `list` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-type`, `--ids`, `--page`, `--partial-name-search`, `--size`, `--include-pagination` | -| `export` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--version` | -| `publish` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--comment`, `--tag-ids`, `--body`, `--body-file` | -| `import` | `--org-id` *(required)*, `--project-id` *(required)*, `--overwrite`, `--flow-type` | +| `export-legacy` | `--flow-id` *(required)*, `--version` | +| `list` | `--flow-type`, `--ids`, `--page`, `--partial-name-search`, `--search-by`, `--size`, `--include-pagination`, `--is-validation` | +| `get` | `--flow-id` *(required)*, `--flow-type` | +| `validate-draft` | `--flow-id` *(required)*, `--version-id`, `--flow-type` | +| `export` | `--flow-id` *(required)*, `--version`, `--flow-type` | +| `search` | `--query`, `--flow-type`, `--page`, `--size`, `--key-value-filter` | +| `import-legacy` | `--overwrite`, `--flow-type` | +| `publish` | `--flow-id` *(required)*, `--skip-validation`, `--flow-type`, `--comment`, `--tag-ids`, `--body`, `--body-file` | +| `lock` | `--flow-id` *(required)*, `--flow-type` | +| `unlock` | `--flow-id` *(required)*, `--flow-type` | +| `validate` | `--body`, `--body-file` | +| `import` | `--overwrite`, `--flow-type`, `--body`, `--body-file` | +| `save-draft` | `--flow-id` *(required)*, `--expected-version`, `--flow-type`, `--body`, `--body-file` | +| `patch-draft` | `--flow-id` *(required)*, `--expected-version`, `--flow-type`, `--body`, `--body-file` | +| `delete` | `--flow-id` *(required)*, `--force`, `--skip-rs-epcheck`, `--flow-type` | ### callbacks | Command | Flags | |---|---| -| `get-scheduled` | `--org-id` *(required)*, `--callback-number`, `--assignee-agent`, `--page`, `--page-size`, `--sort-by`, `--sort-order` | -| `get-scheduled-id` | `--org-id` *(required)*, `--id` *(required)* | -| `schedule` | `--org-id` *(required)*, `--customer-name`, `--callback-number`, `--timezone`, `--schedule-date`, `--start-time`, `--end-time`, `--queue-id`, `--callback-reason`, `--source-interaction`, `--assignee-agent`, `--body`, `--body-file` | -| `update-scheduled-id` | `--org-id` *(required)*, `--id` *(required)*, `--customer-name`, `--callback-number`, `--timezone`, `--schedule-date`, `--start-time`, `--end-time`, `--queue-id`, `--callback-reason`, `--source-interaction`, `--assignee-agent`, `--body`, `--body-file` | -| `delete-scheduled-id` | `--org-id` *(required)*, `--id` *(required)* | +| `get-scheduled` | `--callback-number`, `--assignee-agent`, `--page`, `--page-size`, `--sort-by`, `--sort-order` | +| `get-scheduled-id` | `--id` *(required)* | +| `schedule` | `--customer-name`, `--callback-number`, `--timezone`, `--schedule-date`, `--start-time`, `--end-time`, `--queue-id`, `--callback-reason`, `--source-interaction`, `--assignee-agent`, `--body`, `--body-file` | +| `update-scheduled-id` | `--id` *(required)*, `--customer-name`, `--callback-number`, `--timezone`, `--schedule-date`, `--start-time`, `--end-time`, `--queue-id`, `--callback-reason`, `--source-interaction`, `--assignee-agent`, `--body`, `--body-file` | +| `delete-scheduled-id` | `--id` *(required)* | ### ai-feature | Command | Flags | |---|---| -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--page`, `--page-size` | -| `get-question-mapped-autocsat-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-question-mapped-autocsat` | `--orgid` *(required)*, `--filter`, `--attributes`, `--page`, `--page-size` | -| `create-question-mapped-autocsat` | `--orgid` *(required)*, `--question-id`, `--questionnaire-id`, `--organization-id`, `--id`, `--version`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `bulk-save-question-mapped-autocsat` | `--orgid` *(required)*, `--body`, `--body-file` | -| `patch-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `delete-question-mapped-autocsat-id` | `--orgid` *(required)*, `--id` *(required)* | +| `get-id` | `--id` *(required)* | +| `list` | `--filter`, `--attributes`, `--page`, `--page-size` | +| `get-question-mapped-autocsat-id` | `--id` *(required)* | +| `list-question-mapped-autocsat` | `--filter`, `--attributes`, `--page`, `--page-size` | +| `create-question-mapped-autocsat` | `--question-id`, `--questionnaire-id`, `--organization-id`, `--id`, `--version`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `bulk-save-question-mapped-autocsat` | `--body`, `--body-file` | +| `patch-id` | `--id` *(required)*, `--body`, `--body-file` | +| `delete-question-mapped-autocsat-id` | `--id` *(required)* | ### agent-personal-greeting-files | Command | Flags | |---|---| -| `get-id` | `--orgid` *(required)*, `--id` *(required)*, `--include-url` | -| `list` | `--orgid` *(required)*, `--filter`, `--search`, `--attributes`, `--page`, `--page-size`, `--include-agent-details` | -| `create` | `--orgid` *(required)*, `--body`, `--body-file` | -| `delete-references` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `patch-id` | `--orgid` *(required)*, `--id` *(required)*, `--attribute-tag`, `--greeting-purpose-id`, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `get-id` (aliases: `get-id-v2-api`) | `--id` *(required)*, `--include-url` | +| `list` | `--filter`, `--search`, `--attributes`, `--page`, `--page-size`, `--include-agent-details` | +| `create` (aliases: `create-v2-api`) | `--body`, `--body-file` | +| `delete-references` (aliases: `delete-references-1`) | `--body`, `--body-file` | +| `update-id` (aliases: `update-id-v2-api`) | `--id` *(required)*, `--body`, `--body-file` | +| `patch-id` (aliases: `patch-id-v2-api`) | `--id` *(required)*, `--attribute-tag`, `--greeting-purpose-id`, `--body`, `--body-file` | +| `delete-id` (aliases: `delete-id-v2-api`) | `--id` *(required)* | ### journey-customer-identification @@ -914,14 +959,14 @@ webex cc address-book delete-entry-id --id | Command | Flags | |---|---| -| `get-id` | `--orgid` *(required)*, `--id` *(required)* | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | -| `create` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-default` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `bulk-partial-update` | `--orgid` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `get-id` | `--id` *(required)* | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | +| `create` | `--body`, `--body-file` | +| `update-default` | `--body`, `--body-file` | +| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `bulk-partial-update` | `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### contact-list-management @@ -951,81 +996,39 @@ webex cc address-book delete-entry-id --id | Command | Flags | |---|---| -| `list-definitions` | `--org-id` *(required)*, `--project-id` *(required)* | -| `describe` | `--org-id` *(required)*, `--project-id` *(required)*, `--activity-name` *(required)* | -| `get-input-choices` | `--org-id` *(required)*, `--project-id` *(required)*, `--activity-name` *(required)*, `--input-name` *(required)*, `--mode`, `--query`, `--value`, `--parent_inputs` | -| `list-definitions-2` | `--org-id` *(required)*, `--project-id` *(required)* | -| `describe-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--activity-name` *(required)* | -| `get-input-choices-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--activity-name` *(required)*, `--input-name` *(required)*, `--search`, `--validate`, `--parent-value`, `--parent-input-name` | +| `list-definitions` | — | +| `describe` | `--activity-name` *(required)* | +| `get-input-choices` | `--activity-name` *(required)*, `--input-name` *(required)*, `--search`, `--validate`, `--parent-value`, `--parent-input-name` | ### events | Command | Flags | |---|---| -| `list-specifications` | `--org-id` *(required)*, `--project-id` *(required)* | -| `list-specifications-2` | `--org-id` *(required)*, `--project-id` *(required)* | - -### flows - -| Command | Flags | -|---|---| -| `list` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-type`, `--ids`, `--page`, `--partial-name-search`, `--search-by`, `--size`, `--include-pagination`, `--is-validation` | -| `get` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--flow-type` | -| `validate-draft` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--version-id`, `--flow-type` | -| `export` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--version`, `--flow-type` | -| `list-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-type`, `--ids`, `--page`, `--partial-name-search`, `--search-by`, `--size`, `--include-pagination`, `--is-validation` | -| `get-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--flow-type` | -| `validate-draft-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--version-id`, `--flow-type` | -| `export-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--version`, `--flow-type` | -| `search` | `--org-id` *(required)*, `--project-id` *(required)*, `--query`, `--flow-type`, `--page`, `--size`, `--key-value-filter` | -| `publish` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--skip-validation`, `--flow-type`, `--comment`, `--tag-ids`, `--body`, `--body-file` | -| `lock` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--flow-type` | -| `unlock` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--flow-type` | -| `validate` | `--org-id` *(required)*, `--project-id` *(required)*, `--body`, `--body-file` | -| `import` | `--org-id` *(required)*, `--project-id` *(required)*, `--overwrite`, `--flow-type`, `--body`, `--body-file` | -| `save-draft` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--expected-version`, `--flow-type`, `--body`, `--body-file` | -| `publish-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--skip-validation`, `--flow-type`, `--comment`, `--tag-ids`, `--body`, `--body-file` | -| `lock-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--flow-type` | -| `unlock-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--flow-type` | -| `validate-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--body`, `--body-file` | -| `import-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--overwrite`, `--flow-type`, `--body`, `--body-file` | -| `save-draft-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--expected-version`, `--flow-type`, `--body`, `--body-file` | -| `patch-draft` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--expected-version`, `--flow-type`, `--body`, `--body-file` | -| `patch-draft-2` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--expected-version`, `--flow-type`, `--body`, `--body-file` | -| `delete` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--force`, `--skip-rs-epcheck`, `--flow-type` | +| `list-specifications` | — | ### functions | Command | Flags | |---|---| -| `list-custom` | `--org-id` *(required)*, `--is-partial-match`, `--is-case-sensitive`, `--name`, `--language`, `--status`, `--sort-by`, `--page`, `--size`, `--ids`, `--fields`, `--is-validation` | -| `get-custom` | `--org-id` *(required)*, `--id` *(required)*, `--version-or-tag`, `--meta-data-only` | -| `list-options` | `--org-id` *(required)*, `--language`, `--runtime` | -| `create-custom` | `--org-id` *(required)*, `--body`, `--body-file` | -| `import-custom` | `--org-id` *(required)*, `--overwrite`, `--associated-rcs` | -| `unlock-custom` | `--org-id` *(required)*, `--id` *(required)* | -| `lock-custom` | `--org-id` *(required)*, `--id` *(required)* | -| `test-custom` | `--org-id` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `publish-custom` | `--org-id` *(required)*, `--id` *(required)*, `--tags`, `--comment`, `--key_0`, `--key_1`, `--key_2`, `--key_3`, `--body`, `--body-file` | -| `export-custom` | `--org-id` *(required)*, `--id` *(required)*, `--version-or-tag` | -| `update-custom` | `--org-id` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `delete-custom` | `--org-id` *(required)*, `--id` *(required)*, `--is-force-deletion` | - -### legacy-flows - -| Command | Flags | -|---|---| -| `export` | `--org-id` *(required)*, `--project-id` *(required)*, `--flow-id` *(required)*, `--version`, `--flow-type` | -| `import` | `--org-id` *(required)*, `--project-id` *(required)*, `--overwrite`, `--flow-type` | +| `list` | `--is-partial-match`, `--is-case-sensitive`, `--name`, `--language`, `--status`, `--sort-by`, `--page`, `--size`, `--ids`, `--fields`, `--is-validation` | +| `get` | `--id` *(required)*, `--version-or-tag`, `--meta-data-only` | +| `list-options` | `--language`, `--runtime` | +| `create` | `--body`, `--body-file` | +| `import` | `--overwrite`, `--associated-rcs` | +| `unlock` | `--id` *(required)* | +| `lock` | `--id` *(required)* | +| `test` | `--id` *(required)*, `--body`, `--body-file` | +| `publish` | `--id` *(required)*, `--tags`, `--comment`, `--key_0`, `--key_1`, `--key_2`, `--key_3`, `--body`, `--body-file` | +| `export` | `--id` *(required)*, `--version-or-tag` | +| `update` | `--id` *(required)*, `--body`, `--body-file` | +| `delete` | `--id` *(required)*, `--is-force-deletion` | ### templates | Command | Flags | |---|---| -| `list-flow` | `--org-id` *(required)*, `--project-id` *(required)*, `--type` | -| `get-flow` | `--org-id` *(required)*, `--project-id` *(required)*, `--id` *(required)* | -| `list-flow-2` | `--type` | -| `get-flow-2` | `--id` *(required)* | +| `list-flow` | `--type` | +| `get-flow` | `--id` *(required)* | ### campaign-group @@ -1043,33 +1046,33 @@ webex cc address-book delete-entry-id --id | Command | Flags | |---|---| -| `get-id` | `--orgid` *(required)*, `--id` *(required)*, `--include-channel-name` | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-count`, `--single-object-response`, `--include-channel-name`, `--exclude-epassociated` | -| `create` | `--orgid` *(required)*, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)*, `--body`, `--body-file` | -| `patch-id` | `--orgid` *(required)*, `--id` *(required)*, `--value-type`, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `get-id` | `--id` *(required)*, `--include-channel-name` | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-count`, `--single-object-response`, `--include-channel-name`, `--exclude-epassociated` | +| `create` | `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `patch-id` | `--id` *(required)*, `--value-type`, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### channel | Command | Flags | |---|---| -| `get-id` | `--orgid` *(required)*, `--id` *(required)*, `--include-logo-url-versioned` | -| `list-references` | `--orgid` *(required)*, `--id` *(required)*, `--type`, `--page`, `--page-size` | -| `list` | `--orgid` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-count`, `--single-object-response`, `--include-logo-url-versioned` | -| `create` | `--orgid` *(required)*, `--body`, `--body-file` | -| `bulk-save` | `--orgid` *(required)*, `--body`, `--body-file` | -| `update-id` | `--orgid` *(required)*, `--id` *(required)* | -| `patch-id` | `--orgid` *(required)*, `--id` *(required)*, `--description`, `--logo-type`, `--logo-icon-name`, `--body`, `--body-file` | -| `delete-id` | `--orgid` *(required)*, `--id` *(required)* | +| `get-id` | `--id` *(required)*, `--include-logo-url-versioned` | +| `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | +| `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-count`, `--single-object-response`, `--include-logo-url-versioned` | +| `create` | `--body`, `--body-file` | +| `bulk-save` | `--body`, `--body-file` | +| `update-id` | `--id` *(required)* | +| `patch-id` | `--id` *(required)*, `--description`, `--logo-type`, `--logo-icon-name`, `--body`, `--body-file` | +| `delete-id` | `--id` *(required)* | ### usage-reports | Command | Flags | |---|---| -| `get-available-types` | — | +| `list-resource-types` | — | | `list` | `--resource-type`, `--created-after`, `--created-before` | | `get` | `--report-id` *(required)* | | `download-file` | `--file-id` *(required)* | diff --git a/skill/device/SKILL.md b/skill/device/SKILL.md index 13f62a9..cb348a1 100644 --- a/skill/device/SKILL.md +++ b/skill/device/SKILL.md @@ -197,6 +197,7 @@ webex device hot-desk delete-session --session-id ## Command Reference > Auto-generated from Postman collections. Run `make codegen` to update. +> Organization defaults to the authenticated account; use `--organization` to override. ### device-call diff --git a/skill/meetings/SKILL.md b/skill/meetings/SKILL.md index 672c989..db6b1d1 100644 --- a/skill/meetings/SKILL.md +++ b/skill/meetings/SKILL.md @@ -230,10 +230,17 @@ webex meetings meeting-polls list --meeting-id 7. **Admin scope for list** — `list-admin-compliance-officer` (recordings and transcripts) requires `spark-admin:meetings_read` or compliance officer scope. `--host-email` on `participants list-meeting` also requires admin scope. +## Group meetings and recording queries + +Service apps with group meeting access can use `meetings list-group`, `meetings patch-group`, and `meetings update-group-control-status` to find/update meetings and control recording. The caller must satisfy the API's group/site access requirements. + +`recordings query` and `recordings query-admin-compliance-officer` search recordings using filters in a JSON request body. These searches use POST and therefore the MCP `webex_write` dispatcher. + ## Command Reference > Auto-generated from Postman collections. Run `make codegen` to update. +> Organization defaults to the authenticated account; use `--organization` to override. ### chats diff --git a/skill/messaging/SKILL.md b/skill/messaging/SKILL.md index 27f4073..d4a4c5c 100644 --- a/skill/messaging/SKILL.md +++ b/skill/messaging/SKILL.md @@ -234,10 +234,24 @@ webex messaging events list --resource messages --type created 6. **Compliance officer memberships** — query all rooms a person belongs to org-wide via `memberships list --person-email ` (no `--room-id`). Requires compliance officer scope. +## Hybrid Data Security + +Use `webex messaging hds` (`hybrid-data-security` is a group alias) to inspect organizations, clusters, nodes, network-test results, alarms, and resource usage. The overlapping upstream groups are consolidated. + +```bash +webex messaging hds list-clusters-org --organization-id +webex messaging hds list-nodes-cluster --cluster-id +webex messaging hds get-alarms-node --node-id +webex messaging hds get-usage-node --node-id +``` + +Distinct older routes remain separate: `get-database-org` versus `get-database-config-org`, and `get-multi-tenant-org` versus `list-tenants-org`. Existing numeric spellings remain aliases for the latter two operations. + ## Command Reference > Auto-generated from Postman collections. Run `make codegen` to update. +> Organization defaults to the authenticated account; use `--organization` to override. ### attachment-actions @@ -348,6 +362,8 @@ webex messaging events list --resource messages --type created ### hds +Group aliases: `hybrid-data-security`. + | Command | Flags | |---|---| | `get-test-results-node` | `--node-id` *(required)*, `--trigger-type` | @@ -357,27 +373,11 @@ webex messaging events list --resource messages --type created | `get-database-org` | `--organization-id` *(required)* | | `get-multi-tenant-org` | `--organization-id` *(required)* | | `get-availability-cluster` | `--cluster-id` *(required)*, `--from`, `--to`, `--last` | -| `get-database-org-2` | `--organization-id` *(required)* | -| `get-multi-tenant-org-2` | `--organization-id` *(required)* | +| `get-database-config-org` (aliases: `get-database-org-2`) | `--organization-id` *(required)* | +| `list-tenants-org` (aliases: `get-multi-tenant-org-2`) | `--organization-id` *(required)* | | `list-nodes-cluster` | `--cluster-id` *(required)* | | `list-clusters-org` | `--organization-id` *(required)* | | `get-alarms-node` | `--node-id` *(required)*, `--from`, `--to`, `--last` | | `get-usage-node` | `--node-id` *(required)*, `--from`, `--to`, `--last` | -### hybrid-data-security - -| Command | Flags | -|---|---| -| `get-org` | `--organization-id` *(required)* | -| `list-clusters-org` | `--organization-id` *(required)* | -| `get-cluster` | `--cluster-id` *(required)* | -| `list-nodes-cluster` | `--cluster-id` *(required)* | -| `get-node` | `--node-id` *(required)* | -| `get-database-org` | `--organization-id` *(required)* | -| `get-multi-tenant-org` | `--organization-id` *(required)* | -| `get-alarms-node` | `--node-id` *(required)*, `--from`, `--to`, `--last` | -| `get-test-results-node` | `--node-id` *(required)*, `--trigger-type` | -| `get-usage-node` | `--node-id` *(required)*, `--from`, `--to`, `--last` | -| `get-availability-cluster` | `--cluster-id` *(required)*, `--from`, `--to`, `--last` | - From b815c9f84450ed9f149946b94ba4ff7a0b00a915 Mon Sep 17 00:00:00 2001 From: Ed Umansky Date: Fri, 9 Oct 2026 13:29:53 -0600 Subject: [PATCH 3/6] Shorten redundant ID command names and preserve compatibility aliases --- README.md | 2 + cmd/cc/address_book.go | 27 +-- cmd/cc/agent_personal_greeting_files.go | 24 +-- cmd/cc/ai_feature.go | 18 +- cmd/cc/asset.go | 36 ++-- cmd/cc/audio_files.go | 36 ++-- cmd/cc/auto_csat.go | 18 +- cmd/cc/auxiliary_code.go | 27 +-- cmd/cc/business_hour.go | 27 +-- cmd/cc/channel.go | 36 ++-- cmd/cc/contact_number.go | 27 +-- cmd/cc/contact_service_queue.go | 27 +-- cmd/cc/desktop_layout.go | 27 +-- cmd/cc/desktop_profile.go | 27 +-- cmd/cc/dial_plan.go | 21 +- cmd/cc/entry_point.go | 27 +-- cmd/cc/generated_summaries.go | 18 +- cmd/cc/global_variables.go | 27 +-- cmd/cc/holiday_list.go | 27 +-- cmd/cc/multimedia_profile.go | 27 +-- cmd/cc/outdial_ani.go | 27 +-- cmd/cc/overrides.go | 27 +-- cmd/cc/resource_collection.go | 27 +-- cmd/cc/site.go | 27 +-- cmd/cc/skill.go | 27 +-- cmd/cc/skill_profile.go | 27 +-- cmd/cc/team.go | 27 +-- cmd/cc/user_profiles.go | 27 +-- cmd/cc/users.go | 27 +-- cmd/cc/work_types.go | 27 +-- codegen/INVENTORY.md | 184 +++++++++++++++-- codegen/NAMING.md | 107 +++++++++- codegen/extract_api_spec.py | 7 +- codegen/test_naming_overrides.py | 20 ++ site/src/content/docs/cc.mdx | 6 +- skill/cc/SKILL.md | 254 ++++++++++++------------ 36 files changed, 856 insertions(+), 498 deletions(-) diff --git a/README.md b/README.md index 375cf1e..a8f9504 100644 --- a/README.md +++ b/README.md @@ -115,6 +115,8 @@ All upload commands support `--dry-run` to preview the request without sending i ## Postman refresh: command changes +Resource operations use `get`, `delete`, `patch`, and `update` with `--id`; previous `get-id`, `delete-id`, `patch-id`, and `update-id` spellings remain aliases. + - Calling adds `call-controls-for-me` and `metrics get-call-quality-stats`. - Contact Center adds flow activity/event/template discovery, custom functions, assets/channels, usage reports, campaign groups, search metadata, and completed-task variable updates. - `cc flow import`/`export` now use the current FlowV2 format. Use `export-legacy` for raw FDL; `import-legacy` upload handling remains incomplete. `functions import` also needs multipart upload handling. diff --git a/cmd/cc/address_book.go b/cmd/cc/address_book.go index 090a0cd..6d15da5 100644 --- a/cmd/cc/address_book.go +++ b/cmd/cc/address_book.go @@ -365,13 +365,14 @@ func init() { addressBookCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Address Book by ID", - Long: `Retrieve an existing Address Book by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Address Book by ID", + Long: `Retrieve an existing Address Book by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v3/address-book/{id}") req.PathParam("orgid", orgid) @@ -397,7 +398,7 @@ func init() { addressBookCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var name string @@ -409,9 +410,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Address Book by ID", - Long: `Update an existing Address Book by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Address Book by ID", + Long: `Update an existing Address Book by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/v3/address-book/{id}") req.PathParam("orgid", orgid) @@ -453,13 +455,14 @@ func init() { addressBookCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Address Book by ID", - Long: `Delete an existing Address Book by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Address Book by ID", + Long: `Delete an existing Address Book by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/v3/address-book/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/agent_personal_greeting_files.go b/cmd/cc/agent_personal_greeting_files.go index a8746f6..d530559 100644 --- a/cmd/cc/agent_personal_greeting_files.go +++ b/cmd/cc/agent_personal_greeting_files.go @@ -91,13 +91,13 @@ func init() { agentPersonalGreetingFilesCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string var includeUrl string cmd := &cobra.Command{ - Use: "get-id", - Aliases: []string{"get-id-v2-api"}, + Use: "get", + Aliases: []string{"get-id", "get-id-v2-api"}, Short: "Get specific Greeting File by ID", Long: `Retrieve an existing Greeting File by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { @@ -127,14 +127,14 @@ func init() { agentPersonalGreetingFilesCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Aliases: []string{"update-id-v2-api"}, + Use: "update", + Aliases: []string{"update-id", "update-id-v2-api"}, Short: "Update specific Greeting File by ID", Long: `Update an existing Greeting File by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { @@ -164,12 +164,12 @@ func init() { agentPersonalGreetingFilesCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Aliases: []string{"delete-id-v2-api"}, + Use: "delete", + Aliases: []string{"delete-id", "delete-id-v2-api"}, Short: "Delete specific Greeting File by ID", Long: `Delete an existing Greeting File by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { @@ -190,7 +190,7 @@ func init() { agentPersonalGreetingFilesCmd.AddCommand(cmd) } - { // patch-id + { // patch var orgid string var id string var attributeTag string @@ -198,8 +198,8 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "patch-id", - Aliases: []string{"patch-id-v2-api"}, + Use: "patch", + Aliases: []string{"patch-id", "patch-id-v2-api"}, Short: "Partially update Greeting File by ID", Long: `Partially update Greeting File by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/cmd/cc/ai_feature.go b/cmd/cc/ai_feature.go index c44df26..7a1955a 100644 --- a/cmd/cc/ai_feature.go +++ b/cmd/cc/ai_feature.go @@ -27,13 +27,14 @@ var aiFeatureCmd = &cobra.Command{ func init() { cmd.CcCmd.AddCommand(aiFeatureCmd) - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific AI Feature resource by ID", - Long: `Retrieve an existing AI Feature resource by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific AI Feature resource by ID", + Long: `Retrieve an existing AI Feature resource by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/ai-feature/{id}") req.PathParam("orgid", orgid) @@ -59,15 +60,16 @@ func init() { aiFeatureCmd.AddCommand(cmd) } - { // patch-id + { // patch var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "patch-id", - Short: "Partially update AI Feature resource by ID", - Long: `Partially update AI Feature resource by ID in a given organization.`, + Use: "patch", + Aliases: []string{"patch-id"}, + Short: "Partially update AI Feature resource by ID", + Long: `Partially update AI Feature resource by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PATCH", "/organization/{orgid}/ai-feature/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/asset.go b/cmd/cc/asset.go index 08d5fc8..f6002fb 100644 --- a/cmd/cc/asset.go +++ b/cmd/cc/asset.go @@ -91,14 +91,15 @@ func init() { assetCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string var includeChannelName string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Asset by ID", - Long: `Retrieve an existing Asset by ID in a given organization. Set includeChannelName to true to include the channel name in the response.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Asset by ID", + Long: `Retrieve an existing Asset by ID in a given organization. Set includeChannelName to true to include the channel name in the response.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/asset/{id}") req.PathParam("orgid", orgid) @@ -126,15 +127,16 @@ func init() { assetCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Asset by ID", - Long: `Update an existing Asset by ID in a given organization. Supported for WORK_ITEM assets. For CUSTOM_MESSAGING assets, use PATCH instead.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Asset by ID", + Long: `Update an existing Asset by ID in a given organization. Supported for WORK_ITEM assets. For CUSTOM_MESSAGING assets, use PATCH instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/asset/{id}") req.PathParam("orgid", orgid) @@ -162,13 +164,14 @@ func init() { assetCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Asset by ID", - Long: `Delete an existing Asset by ID in a given organization. Validates whether the asset is associated with any flow before deletion.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Asset by ID", + Long: `Delete an existing Asset by ID in a given organization. Validates whether the asset is associated with any flow before deletion.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/asset/{id}") req.PathParam("orgid", orgid) @@ -187,16 +190,17 @@ func init() { assetCmd.AddCommand(cmd) } - { // patch-id + { // patch var orgid string var id string var valueType string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "patch-id", - Short: "Partially update Asset by ID", - Long: `Partially update Asset by ID in a given organization. Supported only for CUSTOM_MESSAGING assets. Send only the fields to change; absent fields retain their current values. webhookConfig is optional; omit it to keep the existing credentials. For WORK_ITEM assets, use PUT instead.`, + Use: "patch", + Aliases: []string{"patch-id"}, + Short: "Partially update Asset by ID", + Long: `Partially update Asset by ID in a given organization. Supported only for CUSTOM_MESSAGING assets. Send only the fields to change; absent fields retain their current values. webhookConfig is optional; omit it to keep the existing credentials. For WORK_ITEM assets, use PUT instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PATCH", "/organization/{orgid}/asset/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/audio_files.go b/cmd/cc/audio_files.go index a810a56..accbd58 100644 --- a/cmd/cc/audio_files.go +++ b/cmd/cc/audio_files.go @@ -57,14 +57,15 @@ func init() { audioFilesCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string var includeUrl string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Audio File by ID", - Long: `Retrieve an existing Audio File by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Audio File by ID", + Long: `Retrieve an existing Audio File by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/audio-file/{id}") req.PathParam("orgid", orgid) @@ -92,15 +93,16 @@ func init() { audioFilesCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Audio File by ID", - Long: `Update an existing Audio File by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Audio File by ID", + Long: `Update an existing Audio File by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/audio-file/{id}") req.PathParam("orgid", orgid) @@ -128,13 +130,14 @@ func init() { audioFilesCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Audio File by ID", - Long: `Delete an existing Audio File by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Audio File by ID", + Long: `Delete an existing Audio File by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/audio-file/{id}") req.PathParam("orgid", orgid) @@ -153,16 +156,17 @@ func init() { audioFilesCmd.AddCommand(cmd) } - { // patch-id + { // patch var orgid string var id string var description string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "patch-id", - Short: "Partially update Audio File by ID", - Long: `Partially update Audio File by ID in a given organization.`, + Use: "patch", + Aliases: []string{"patch-id"}, + Short: "Partially update Audio File by ID", + Long: `Partially update Audio File by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PATCH", "/organization/{orgid}/audio-file/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/auto_csat.go b/cmd/cc/auto_csat.go index 95aa53e..93e4bb4 100644 --- a/cmd/cc/auto_csat.go +++ b/cmd/cc/auto_csat.go @@ -186,13 +186,14 @@ func init() { autoCsatCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string 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. Deprecated. Use GET /ai-feature/auto-csat/{id} instead.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Auto CSAT resource by ID", + 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) @@ -218,7 +219,7 @@ func init() { autoCsatCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var agentInclusionType string @@ -232,9 +233,10 @@ func init() { 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. Deprecated. Use PUT /ai-feature/auto-csat/{id} instead.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Auto CSAT resource by ID", + 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) diff --git a/cmd/cc/auxiliary_code.go b/cmd/cc/auxiliary_code.go index 2cd9825..773b59b 100644 --- a/cmd/cc/auxiliary_code.go +++ b/cmd/cc/auxiliary_code.go @@ -267,13 +267,14 @@ func init() { auxiliaryCodeCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Auxiliary Code by ID", - Long: `Retrieve an existing Auxiliary Code by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Auxiliary Code by ID", + Long: `Retrieve an existing Auxiliary Code by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/auxiliary-code/{id}") req.PathParam("orgid", orgid) @@ -299,7 +300,7 @@ func init() { auxiliaryCodeCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var active bool @@ -316,9 +317,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Auxiliary Code by ID", - Long: `Update an existing Auxiliary Code by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Auxiliary Code by ID", + Long: `Update an existing Auxiliary Code by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/auxiliary-code/{id}") req.PathParam("orgid", orgid) @@ -370,13 +372,14 @@ func init() { auxiliaryCodeCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Auxiliary Code by ID", - Long: `Delete an existing Auxiliary Code by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Auxiliary Code by ID", + Long: `Delete an existing Auxiliary Code by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/auxiliary-code/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/business_hour.go b/cmd/cc/business_hour.go index cd53404..560c266 100644 --- a/cmd/cc/business_hour.go +++ b/cmd/cc/business_hour.go @@ -178,13 +178,14 @@ func init() { businessHourCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Business Hours resource by ID", - Long: `Retrieve an existing Business Hours resource by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Business Hours resource by ID", + Long: `Retrieve an existing Business Hours resource by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/business-hours/{id}") req.PathParam("orgid", orgid) @@ -210,15 +211,16 @@ func init() { businessHourCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Business Hours resource by ID", - Long: `Update an existing Business Hours resource by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Business Hours resource by ID", + Long: `Update an existing Business Hours resource by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/business-hours/{id}") req.PathParam("orgid", orgid) @@ -246,13 +248,14 @@ func init() { businessHourCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Business Hours resource by ID", - Long: `Delete an existing Business Hours resource by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Business Hours resource by ID", + Long: `Delete an existing Business Hours resource by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/business-hours/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/channel.go b/cmd/cc/channel.go index 76788af..2885141 100644 --- a/cmd/cc/channel.go +++ b/cmd/cc/channel.go @@ -89,14 +89,15 @@ func init() { channelCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string var includeLogoUrlVersioned string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Channel by ID", - Long: `Retrieve an existing Channel by ID in a given organization. Set includeLogoUrlVersioned to true to include logoUrlVersioned in the response.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Channel by ID", + Long: `Retrieve an existing Channel by ID in a given organization. Set includeLogoUrlVersioned to true to include logoUrlVersioned in the response.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/channel/{id}") req.PathParam("orgid", orgid) @@ -124,13 +125,14 @@ func init() { channelCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Channel by ID", - Long: `Update an existing Channel by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Channel by ID", + Long: `Update an existing Channel by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/channel/{id}") req.PathParam("orgid", orgid) @@ -149,13 +151,14 @@ func init() { channelCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Channel by ID", - Long: `Delete an existing Channel by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Channel by ID", + Long: `Delete an existing Channel by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/channel/{id}") req.PathParam("orgid", orgid) @@ -174,7 +177,7 @@ func init() { channelCmd.AddCommand(cmd) } - { // patch-id + { // patch var orgid string var id string var description string @@ -183,9 +186,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "patch-id", - Short: "Partially update Channel by ID", - Long: `Partially update a channel by ID. Only the supplied fields are changed; absent fields retain their current values. Patchable fields: name, description, logoType (MOMENTUM only), logoIconName. logoUrl and logoUrlVersioned cannot be changed by using PATCH; use PUT to update the logo image. channelType cannot be changed after creation. in a given organization.`, + Use: "patch", + Aliases: []string{"patch-id"}, + Short: "Partially update Channel by ID", + Long: `Partially update a channel by ID. Only the supplied fields are changed; absent fields retain their current values. Patchable fields: name, description, logoType (MOMENTUM only), logoIconName. logoUrl and logoUrlVersioned cannot be changed by using PATCH; use PUT to update the logo image. channelType cannot be changed after creation. in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PATCH", "/organization/{orgid}/channel/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/contact_number.go b/cmd/cc/contact_number.go index dfde125..783bb24 100644 --- a/cmd/cc/contact_number.go +++ b/cmd/cc/contact_number.go @@ -166,13 +166,14 @@ func init() { contactNumberCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Contact Number by ID", - Long: `Retrieve an existing Contact Number by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Contact Number by ID", + Long: `Retrieve an existing Contact Number by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/contact-number/{id}") req.PathParam("orgid", orgid) @@ -198,7 +199,7 @@ func init() { contactNumberCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var number string @@ -207,9 +208,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Contact Number by ID", - Long: `Update an existing Contact Number by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Contact Number by ID", + Long: `Update an existing Contact Number by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/contact-number/{id}") req.PathParam("orgid", orgid) @@ -245,13 +247,14 @@ func init() { contactNumberCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Contact Number by ID", - Long: `Delete an existing Contact Number by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Contact Number by ID", + Long: `Delete an existing Contact Number by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/contact-number/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/contact_service_queue.go b/cmd/cc/contact_service_queue.go index 12313c8..a1e85bf 100644 --- a/cmd/cc/contact_service_queue.go +++ b/cmd/cc/contact_service_queue.go @@ -345,14 +345,15 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string var agentsUpdatedInfo string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Contact Service Queue by ID", - Long: `Retrieve an existing Contact Service Queue by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-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}") req.PathParam("orgid", orgid) @@ -380,15 +381,16 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Contact Service Queue by ID", - Long: `Update an existing Contact Service Queue by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Contact Service Queue by ID", + Long: `Update an existing Contact Service Queue by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/v2/contact-service-queue/{id}") req.PathParam("orgid", orgid) @@ -416,13 +418,14 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Contact Service Queue by ID", - Long: `Delete an existing Contact Service Queue by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Contact Service Queue by ID", + Long: `Delete an existing Contact Service Queue by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/contact-service-queue/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/desktop_layout.go b/cmd/cc/desktop_layout.go index f901b60..a7b8d43 100644 --- a/cmd/cc/desktop_layout.go +++ b/cmd/cc/desktop_layout.go @@ -209,13 +209,14 @@ func init() { desktopLayoutCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Desktop Layout by ID", - Long: `Retrieve an existing Desktop Layout by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Desktop Layout by ID", + Long: `Retrieve an existing Desktop Layout by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/desktop-layout/{id}") req.PathParam("orgid", orgid) @@ -241,7 +242,7 @@ func init() { desktopLayoutCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var defaultJsonModified bool @@ -265,9 +266,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Desktop Layout by ID", - Long: `Update an existing Desktop Layout by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Desktop Layout by ID", + Long: `Update an existing Desktop Layout by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/desktop-layout/{id}") req.PathParam("orgid", orgid) @@ -333,13 +335,14 @@ func init() { desktopLayoutCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Desktop Layout by ID", - Long: `Delete an existing Desktop Layout by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Desktop Layout by ID", + Long: `Delete an existing Desktop Layout by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/desktop-layout/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/desktop_profile.go b/cmd/cc/desktop_profile.go index d538665..aec963c 100644 --- a/cmd/cc/desktop_profile.go +++ b/cmd/cc/desktop_profile.go @@ -354,13 +354,14 @@ func init() { desktopProfileCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Desktop Profile by ID", - Long: `Retrieve an existing Desktop Profile by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Desktop Profile by ID", + Long: `Retrieve an existing Desktop Profile by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/agent-profile/{id}") req.PathParam("orgid", orgid) @@ -386,7 +387,7 @@ func init() { desktopProfileCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var accessBuddyTeam string @@ -442,9 +443,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Desktop Profile by ID", - Long: `Update an existing Desktop Profile by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Desktop Profile by ID", + Long: `Update an existing Desktop Profile by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/agent-profile/{id}") req.PathParam("orgid", orgid) @@ -573,13 +575,14 @@ func init() { desktopProfileCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Desktop Profile by ID", - Long: `Delete an existing Desktop Profile by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Desktop Profile by ID", + Long: `Delete an existing Desktop Profile by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/agent-profile/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/dial_plan.go b/cmd/cc/dial_plan.go index 00704ec..37a6bbd 100644 --- a/cmd/cc/dial_plan.go +++ b/cmd/cc/dial_plan.go @@ -211,12 +211,13 @@ func init() { dialPlanCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Dial Plan by ID", + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Dial Plan by ID", Long: `Retrieve an existing Dial Plan by ID in a given organization. **Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.`, @@ -245,7 +246,7 @@ func init() { dialPlanCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var active bool @@ -262,8 +263,9 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Dial Plan by ID", + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Dial Plan by ID", Long: `Update an existing Dial Plan by ID in a given organization. **Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.`, @@ -318,12 +320,13 @@ func init() { dialPlanCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Dial Plan by ID", + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Dial Plan by ID", Long: `Delete an existing Dial Plan by ID in a given organization. **Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.`, diff --git a/cmd/cc/entry_point.go b/cmd/cc/entry_point.go index f6f0533..0838a16 100644 --- a/cmd/cc/entry_point.go +++ b/cmd/cc/entry_point.go @@ -208,14 +208,15 @@ func init() { entryPointCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string var includeNames string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Entry Point by ID", - Long: `Retrieve an existing Entry Point by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Entry Point by ID", + Long: `Retrieve an existing Entry Point by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/entry-point/{id}") req.PathParam("orgid", orgid) @@ -243,15 +244,16 @@ func init() { entryPointCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Entry Point by ID", - Long: `Update an existing Entry Point by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Entry Point by ID", + Long: `Update an existing Entry Point by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/entry-point/{id}") req.PathParam("orgid", orgid) @@ -279,13 +281,14 @@ func init() { entryPointCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Entry Point by ID", - Long: `Delete an existing Entry Point by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Entry Point by ID", + Long: `Delete an existing Entry Point by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/entry-point/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/generated_summaries.go b/cmd/cc/generated_summaries.go index 566422e..c21a022 100644 --- a/cmd/cc/generated_summaries.go +++ b/cmd/cc/generated_summaries.go @@ -27,13 +27,14 @@ var generatedSummariesCmd = &cobra.Command{ func init() { cmd.CcCmd.AddCommand(generatedSummariesCmd) - { // get-id + { // get var orgid string var id string 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. Deprecated. Use GET /ai-feature/generated-summaries/{id} instead.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Generated Summaries resource by ID", + 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) @@ -59,7 +60,7 @@ func init() { generatedSummariesCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var organizationId string @@ -73,9 +74,10 @@ func init() { 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. Deprecated. Use PUT /ai-feature/generated-summaries/{id} instead.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Generated Summaries resource by ID", + 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) diff --git a/cmd/cc/global_variables.go b/cmd/cc/global_variables.go index e7d4d7a..7123806 100644 --- a/cmd/cc/global_variables.go +++ b/cmd/cc/global_variables.go @@ -220,13 +220,14 @@ func init() { globalVariablesCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Global Variable by ID", - Long: `Retrieve an existing Global Variable by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Global Variable by ID", + Long: `Retrieve an existing Global Variable by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/cad-variable/{id}") req.PathParam("orgid", orgid) @@ -252,7 +253,7 @@ func init() { globalVariablesCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var active bool @@ -271,9 +272,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Global Variable by ID", - Long: `Update an existing Global Variable by ID in a given organization. Required fields in payload are agentEditable, variableType, agentViewable, reportable, active, defaultValue.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Global Variable by ID", + Long: `Update an existing Global Variable by ID in a given organization. Required fields in payload are agentEditable, variableType, agentViewable, reportable, active, defaultValue.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/cad-variable/{id}") req.PathParam("orgid", orgid) @@ -329,13 +331,14 @@ func init() { globalVariablesCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Global Variable by ID", - Long: `Delete an existing Global Variable by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Global Variable by ID", + Long: `Delete an existing Global Variable by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/cad-variable/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/holiday_list.go b/cmd/cc/holiday_list.go index 73a14ec..86878a4 100644 --- a/cmd/cc/holiday_list.go +++ b/cmd/cc/holiday_list.go @@ -178,13 +178,14 @@ func init() { holidayListCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Holiday List by ID", - Long: `Retrieve an existing Holiday List by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Holiday List by ID", + Long: `Retrieve an existing Holiday List by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/holiday-list/{id}") req.PathParam("orgid", orgid) @@ -210,15 +211,16 @@ func init() { holidayListCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Holiday List by ID", - Long: `Update an existing Holiday List by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Holiday List by ID", + Long: `Update an existing Holiday List by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/holiday-list/{id}") req.PathParam("orgid", orgid) @@ -246,13 +248,14 @@ func init() { holidayListCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Holiday List by ID", - Long: `Delete an existing Holiday List by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Holiday List by ID", + Long: `Delete an existing Holiday List by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/holiday-list/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/multimedia_profile.go b/cmd/cc/multimedia_profile.go index cb1550f..8b6d9f5 100644 --- a/cmd/cc/multimedia_profile.go +++ b/cmd/cc/multimedia_profile.go @@ -192,13 +192,14 @@ func init() { multimediaProfileCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Multimedia Profile by ID", - Long: `Retrieve an existing Multimedia Profile by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Multimedia Profile by ID", + Long: `Retrieve an existing Multimedia Profile by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/multimedia-profile/{id}") req.PathParam("orgid", orgid) @@ -224,15 +225,16 @@ func init() { multimediaProfileCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Multimedia Profile by ID", - Long: `Update an existing Multimedia Profile by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Multimedia Profile by ID", + Long: `Update an existing Multimedia Profile by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/multimedia-profile/{id}") req.PathParam("orgid", orgid) @@ -260,13 +262,14 @@ func init() { multimediaProfileCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Multimedia Profile by ID", - Long: `Delete an existing Multimedia Profile by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Multimedia Profile by ID", + Long: `Delete an existing Multimedia Profile by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/multimedia-profile/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/outdial_ani.go b/cmd/cc/outdial_ani.go index f210d77..058f863 100644 --- a/cmd/cc/outdial_ani.go +++ b/cmd/cc/outdial_ani.go @@ -216,13 +216,14 @@ func init() { outdialAniCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Outdial ANI by ID", - Long: `Retrieve an existing Outdial ANI by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Outdial ANI by ID", + Long: `Retrieve an existing Outdial ANI by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/outdial-ani/{id}") req.PathParam("orgid", orgid) @@ -248,15 +249,16 @@ func init() { outdialAniCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Outdial ANI by ID", - Long: `Update an existing Outdial ANI by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Outdial ANI by ID", + Long: `Update an existing Outdial ANI by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/outdial-ani/{id}") req.PathParam("orgid", orgid) @@ -284,13 +286,14 @@ func init() { outdialAniCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Outdial ANI by ID", - Long: `Delete an existing Outdial ANI by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Outdial ANI by ID", + Long: `Delete an existing Outdial ANI by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/outdial-ani/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/overrides.go b/cmd/cc/overrides.go index ea334d8..1fbbe68 100644 --- a/cmd/cc/overrides.go +++ b/cmd/cc/overrides.go @@ -178,13 +178,14 @@ func init() { overridesCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Overrides resource by ID", - Long: `Retrieve an existing Overrides resource by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Overrides resource by ID", + Long: `Retrieve an existing Overrides resource by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/overrides/{id}") req.PathParam("orgid", orgid) @@ -210,15 +211,16 @@ func init() { overridesCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Overrides resource by ID", - Long: `Update an existing Overrides resource by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Overrides resource by ID", + Long: `Update an existing Overrides resource by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/overrides/{id}") req.PathParam("orgid", orgid) @@ -246,13 +248,14 @@ func init() { overridesCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Overrides resource by ID", - Long: `Delete an existing Overrides resource by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Overrides resource by ID", + Long: `Delete an existing Overrides resource by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/overrides/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/resource_collection.go b/cmd/cc/resource_collection.go index 89168ea..e722f94 100644 --- a/cmd/cc/resource_collection.go +++ b/cmd/cc/resource_collection.go @@ -123,13 +123,14 @@ func init() { resourceCollectionCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Resource Collection by ID", - Long: `Retrieve an existing Resource Collection by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Resource Collection by ID", + Long: `Retrieve an existing Resource Collection by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/resource-collection/{id}") req.PathParam("orgid", orgid) @@ -155,15 +156,16 @@ func init() { resourceCollectionCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Resource Collection by ID", - Long: `Update an existing resource collection by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Resource Collection by ID", + Long: `Update an existing resource collection by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/resource-collection/{id}") req.PathParam("orgid", orgid) @@ -191,13 +193,14 @@ func init() { resourceCollectionCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Resource Collection by ID", - Long: `Delete an existing resource collection by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Resource Collection by ID", + Long: `Delete an existing resource collection by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/resource-collection/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/site.go b/cmd/cc/site.go index 7214236..9c13d8e 100644 --- a/cmd/cc/site.go +++ b/cmd/cc/site.go @@ -217,13 +217,14 @@ func init() { siteCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Site by ID", - Long: `Retrieve an existing Site by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Site by ID", + Long: `Retrieve an existing Site by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/site/{id}") req.PathParam("orgid", orgid) @@ -249,7 +250,7 @@ func init() { siteCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var active bool @@ -262,9 +263,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Site by ID", - Long: `Update an existing Site by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Site by ID", + Long: `Update an existing Site by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/site/{id}") req.PathParam("orgid", orgid) @@ -308,13 +310,14 @@ func init() { siteCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Site by ID", - Long: `Delete an existing Site by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Site by ID", + Long: `Delete an existing Site by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/site/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/skill.go b/cmd/cc/skill.go index 9644005..5d1763e 100644 --- a/cmd/cc/skill.go +++ b/cmd/cc/skill.go @@ -199,13 +199,14 @@ func init() { skillCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Skill by ID", - Long: `Retrieve an existing Skill by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Skill by ID", + Long: `Retrieve an existing Skill by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/skill/{id}") req.PathParam("orgid", orgid) @@ -231,15 +232,16 @@ func init() { skillCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Skill by ID", - Long: `Update an existing Skill by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Skill by ID", + Long: `Update an existing Skill by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/skill/{id}") req.PathParam("orgid", orgid) @@ -267,13 +269,14 @@ func init() { skillCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Skill by ID", - Long: `Delete an existing Skill by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Skill by ID", + Long: `Delete an existing Skill by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/skill/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/skill_profile.go b/cmd/cc/skill_profile.go index 86d0693..189d366 100644 --- a/cmd/cc/skill_profile.go +++ b/cmd/cc/skill_profile.go @@ -199,14 +199,15 @@ func init() { skillProfileCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string var includeSkillDetails string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Skill Profile by ID", - Long: `Retrieve an existing Skill Profile by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Skill Profile by ID", + Long: `Retrieve an existing Skill Profile by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/skill-profile/{id}") req.PathParam("orgid", orgid) @@ -234,7 +235,7 @@ func init() { skillProfileCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var activeSkills string @@ -248,9 +249,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Skill Profile by ID", - Long: `Update an existing Skill Profile by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Skill Profile by ID", + Long: `Update an existing Skill Profile by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/skill-profile/{id}") req.PathParam("orgid", orgid) @@ -295,13 +297,14 @@ func init() { skillProfileCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Skill Profile by ID", - Long: `Delete an existing Skill Profile by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Skill Profile by ID", + Long: `Delete an existing Skill Profile by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/skill-profile/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/team.go b/cmd/cc/team.go index 424c2a3..d118a88 100644 --- a/cmd/cc/team.go +++ b/cmd/cc/team.go @@ -263,13 +263,14 @@ func init() { teamCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Team by ID", - Long: `Retrieve an existing Team by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Team by ID", + Long: `Retrieve an existing Team by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/team/{id}") req.PathParam("orgid", orgid) @@ -295,7 +296,7 @@ func init() { teamCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var active string @@ -320,9 +321,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Team by ID", - Long: `Update an existing Team by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Team by ID", + Long: `Update an existing Team by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/team/{id}") req.PathParam("orgid", orgid) @@ -389,13 +391,14 @@ func init() { teamCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Team by ID", - Long: `Delete an existing Team by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Team by ID", + Long: `Delete an existing Team by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/team/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/user_profiles.go b/cmd/cc/user_profiles.go index d8a4c39..da72126 100644 --- a/cmd/cc/user_profiles.go +++ b/cmd/cc/user_profiles.go @@ -163,14 +163,15 @@ func init() { userProfilesCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string var includeNames string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific User Profile by ID", - Long: `Retrieve an existing user profile by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific User Profile by ID", + Long: `Retrieve an existing user profile by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v3/user-profile/{id}") req.PathParam("orgid", orgid) @@ -198,15 +199,16 @@ func init() { userProfilesCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific User Profile by ID", - Long: `Update an existing user profile by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific User Profile by ID", + Long: `Update an existing user profile by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/v3/user-profile/{id}") req.PathParam("orgid", orgid) @@ -234,13 +236,14 @@ func init() { userProfilesCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific User Profile by ID", - Long: `Delete an existing user profile by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific User Profile by ID", + Long: `Delete an existing user profile by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/v3/user-profile/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/users.go b/cmd/cc/users.go index 7c54f24..94e0a30 100644 --- a/cmd/cc/users.go +++ b/cmd/cc/users.go @@ -350,7 +350,7 @@ func init() { usersCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string var includeCount string @@ -361,9 +361,10 @@ func init() { var checkIfUserHasDynamicSkill string var dynamicSkillId string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific User by ID", - Long: `Retrieve an existing Users by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific User by ID", + Long: `Retrieve an existing Users by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/user/{id}") req.PathParam("orgid", orgid) @@ -403,15 +404,16 @@ func init() { usersCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific User by ID", - Long: `Update an existing User by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific User by ID", + Long: `Update an existing User by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/user/{id}") req.PathParam("orgid", orgid) @@ -439,16 +441,17 @@ func init() { usersCmd.AddCommand(cmd) } - { // patch-id + { // patch var orgid string var id string var valueType string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "patch-id", - Short: "Partially update User by ID", - Long: `Partially update User by ID in a given organization.`, + Use: "patch", + Aliases: []string{"patch-id"}, + Short: "Partially update User by ID", + Long: `Partially update User by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PATCH", "/organization/{orgid}/user/{id}") req.PathParam("orgid", orgid) diff --git a/cmd/cc/work_types.go b/cmd/cc/work_types.go index c9b5b5d..f877137 100644 --- a/cmd/cc/work_types.go +++ b/cmd/cc/work_types.go @@ -174,13 +174,14 @@ func init() { workTypesCmd.AddCommand(cmd) } - { // get-id + { // get var orgid string var id string cmd := &cobra.Command{ - Use: "get-id", - Short: "Get specific Work Type by ID", - Long: `Retrieve an existing Work Type by ID in a given organization.`, + Use: "get", + Aliases: []string{"get-id"}, + Short: "Get specific Work Type by ID", + Long: `Retrieve an existing Work Type by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/work-type/{id}") req.PathParam("orgid", orgid) @@ -206,7 +207,7 @@ func init() { workTypesCmd.AddCommand(cmd) } - { // update-id + { // update var orgid string var id string var active bool @@ -219,9 +220,10 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-id", - Short: "Update specific Work Type by ID", - Long: `Update an existing Work Type by ID in a given organization.`, + Use: "update", + Aliases: []string{"update-id"}, + Short: "Update specific Work Type by ID", + Long: `Update an existing Work Type by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/work-type/{id}") req.PathParam("orgid", orgid) @@ -265,13 +267,14 @@ func init() { workTypesCmd.AddCommand(cmd) } - { // delete-id + { // delete var orgid string var id string cmd := &cobra.Command{ - Use: "delete-id", - Short: "Delete specific Work Type by ID", - Long: `Delete an existing Work Type by ID in a given organization.`, + Use: "delete", + Aliases: []string{"delete-id"}, + Short: "Delete specific Work Type by ID", + Long: `Delete an existing Work Type by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/work-type/{id}") req.PathParam("orgid", orgid) diff --git a/codegen/INVENTORY.md b/codegen/INVENTORY.md index a0fc75b..53bdb11 100644 --- a/codegen/INVENTORY.md +++ b/codegen/INVENTORY.md @@ -49,38 +49,73 @@ Counts cover the normalized spec; handwritten commands and codegen exclusions ca | `webex cc activities describe` | `GET /{orgId}/project/{projectId}/v2/activities/{activityName}` | Retrieve a single activity's full definition, including inputs, outputs, named ports, and the JSON Schema for its inputs — all returned inline. | | `webex cc activities get-input-choices` | `GET /{orgId}/project/{projectId}/v2/activities/{activityName}/inputs/{inputName}/choices` | Resolve choices for an activity input | | `webex cc activities list-definitions` | `GET /{orgId}/project/{projectId}/v2/activities` | List all available activity types with their full schemas, including inputs, outputs, ports, and descriptions | +| `webex cc address-book delete` | `DELETE /organization/{orgid}/v3/address-book/{id}` | Delete an existing Address Book by ID in a given organization. | +| `webex cc address-book get` | `GET /organization/{orgid}/v3/address-book/{id}` | Retrieve an existing Address Book by ID in a given organization. | +| `webex cc address-book update` | `PUT /organization/{orgid}/v3/address-book/{id}` | Update an existing Address Book by ID in a given organization. | | `webex cc agent-personal-greeting-files create` | `POST /organization/{orgid}/v2/agent-personal-greeting` | Create a new Greeting File in a given organization. | -| `webex cc agent-personal-greeting-files delete-id` | `DELETE /organization/{orgid}/v2/agent-personal-greeting/{id}` | Delete an existing Greeting File by ID in a given organization. | +| `webex cc agent-personal-greeting-files delete` | `DELETE /organization/{orgid}/v2/agent-personal-greeting/{id}` | Delete an existing Greeting File by ID in a given organization. | | `webex cc agent-personal-greeting-files delete-references` | `POST /organization/{orgid}/agent-personal-greeting/delete-reference` | Removes all references of the specified agent (ciUserId) from greeting files in the given organization | -| `webex cc agent-personal-greeting-files get-id` | `GET /organization/{orgid}/v2/agent-personal-greeting/{id}` | Retrieve an existing Greeting File by ID in a given organization. | -| `webex cc agent-personal-greeting-files patch-id` | `PATCH /organization/{orgid}/v2/agent-personal-greeting/{id}` | Partially update Greeting File by ID in a given organization. | -| `webex cc agent-personal-greeting-files update-id` | `PUT /organization/{orgid}/v2/agent-personal-greeting/{id}` | Update an existing Greeting File by ID in a given organization. | +| `webex cc agent-personal-greeting-files get` | `GET /organization/{orgid}/v2/agent-personal-greeting/{id}` | Retrieve an existing Greeting File by ID in a given organization. | +| `webex cc agent-personal-greeting-files patch` | `PATCH /organization/{orgid}/v2/agent-personal-greeting/{id}` | Partially update Greeting File by ID in a given organization. | +| `webex cc agent-personal-greeting-files update` | `PUT /organization/{orgid}/v2/agent-personal-greeting/{id}` | Update an existing Greeting File by ID in a given organization. | +| `webex cc ai-feature get` | `GET /organization/{orgid}/ai-feature/{id}` | Retrieve an existing AI Feature resource by ID in a given organization. | +| `webex cc ai-feature patch` | `PATCH /organization/{orgid}/ai-feature/{id}` | Partially update AI Feature resource by ID in a given organization. | | `webex cc asset bulk-save` | `POST /organization/{orgid}/asset/bulk` | Create, Update or delete Assets in bulk in a given organization | | `webex cc asset create` | `POST /organization/{orgid}/asset` | Create a new Asset in a given organization | -| `webex cc asset delete-id` | `DELETE /organization/{orgid}/asset/{id}` | Delete an existing Asset by ID in a given organization | -| `webex cc asset get-id` | `GET /organization/{orgid}/asset/{id}` | Retrieve an existing Asset by ID in a given organization | +| `webex cc asset delete` | `DELETE /organization/{orgid}/asset/{id}` | Delete an existing Asset by ID in a given organization | +| `webex cc asset get` | `GET /organization/{orgid}/asset/{id}` | Retrieve an existing Asset by ID in a given organization | | `webex cc asset list` | `GET /organization/{orgid}/v2/asset` | Retrieve a list of Assets in a given organization | | `webex cc asset list-references` | `GET /organization/{orgid}/asset/{id}/incoming-references` | Retrieve a list of all entities that have reference to an existing Asset by ID in a given organization | -| `webex cc asset patch-id` | `PATCH /organization/{orgid}/asset/{id}` | Partially update Asset by ID in a given organization | -| `webex cc asset update-id` | `PUT /organization/{orgid}/asset/{id}` | Update an existing Asset by ID in a given organization | +| `webex cc asset patch` | `PATCH /organization/{orgid}/asset/{id}` | Partially update Asset by ID in a given organization | +| `webex cc asset update` | `PUT /organization/{orgid}/asset/{id}` | Update an existing Asset by ID in a given organization | +| `webex cc audio-files delete` | `DELETE /organization/{orgid}/audio-file/{id}` | Delete an existing Audio File by ID in a given organization. | +| `webex cc audio-files get` | `GET /organization/{orgid}/audio-file/{id}` | Retrieve an existing Audio File by ID in a given organization. | +| `webex cc audio-files patch` | `PATCH /organization/{orgid}/audio-file/{id}` | Partially update Audio File by ID in a given organization. | +| `webex cc audio-files update` | `PUT /organization/{orgid}/audio-file/{id}` | Update an existing Audio File by ID in a given organization. | +| `webex cc auto-csat get` | `GET /organization/{orgid}/auto-csat/{id}` | Retrieve an existing Auto CSAT resource by ID in a given organization | +| `webex cc auto-csat update` | `PUT /organization/{orgid}/auto-csat/{id}` | Update an existing Auto CSAT resource by ID in a given organization | +| `webex cc auxiliary-code delete` | `DELETE /organization/{orgid}/auxiliary-code/{id}` | Delete an existing Auxiliary Code by ID in a given organization. | +| `webex cc auxiliary-code get` | `GET /organization/{orgid}/auxiliary-code/{id}` | Retrieve an existing Auxiliary Code by ID in a given organization. | +| `webex cc auxiliary-code update` | `PUT /organization/{orgid}/auxiliary-code/{id}` | Update an existing Auxiliary Code by ID in a given organization. | +| `webex cc business-hour delete` | `DELETE /organization/{orgid}/business-hours/{id}` | Delete an existing Business Hours resource by ID in a given organization. | +| `webex cc business-hour get` | `GET /organization/{orgid}/business-hours/{id}` | Retrieve an existing Business Hours resource by ID in a given organization. | +| `webex cc business-hour update` | `PUT /organization/{orgid}/business-hours/{id}` | Update an existing Business Hours resource by ID in a given organization. | | `webex cc call-monitoring whisper-coach-request` | `POST /v1/monitor/{interactionId}/coach` | This feature is currently in Beta | | `webex cc campaign-group list` | `GET /v3/campaign-management/campaign-groups/{campaignGroupName}/campaigns` | Retrieves the list of campaigns that belong to the specified campaign group | | `webex cc campaign-manager get-valid-times` | `GET /v1/organization/{orgId}/getValidCampaignTimes` | Gets valid campaign times for a campaign and agent | | `webex cc channel bulk-save` | `POST /organization/{orgid}/channel/bulk` | Create, Update or delete Channels in bulk in a given organization. | | `webex cc channel create` | `POST /organization/{orgid}/channel` | Create a new Channel in a given organization | -| `webex cc channel delete-id` | `DELETE /organization/{orgid}/channel/{id}` | Delete an existing Channel by ID in a given organization. | -| `webex cc channel get-id` | `GET /organization/{orgid}/channel/{id}` | Retrieve an existing Channel by ID in a given organization | +| `webex cc channel delete` | `DELETE /organization/{orgid}/channel/{id}` | Delete an existing Channel by ID in a given organization. | +| `webex cc channel get` | `GET /organization/{orgid}/channel/{id}` | Retrieve an existing Channel by ID in a given organization | | `webex cc channel list` | `GET /organization/{orgid}/v2/channel` | Retrieve a list of Channels in a given organization | | `webex cc channel list-references` | `GET /organization/{orgid}/channel/{id}/incoming-references` | Retrieve a list of all entities that have reference to an existing Channel by ID in a given organization | -| `webex cc channel patch-id` | `PATCH /organization/{orgid}/channel/{id}` | Partially update a channel by ID | -| `webex cc channel update-id` | `PUT /organization/{orgid}/channel/{id}` | Update an existing Channel by ID in a given organization. | +| `webex cc channel patch` | `PATCH /organization/{orgid}/channel/{id}` | Partially update a channel by ID | +| `webex cc channel update` | `PUT /organization/{orgid}/channel/{id}` | Update an existing Channel by ID in a given organization. | | `webex cc contact-list-management update-status-across-campaign-chain` | `PATCH /v3/campaign-management/campaigns/{campaignId}/contacts/{contactId}` | Synchronously closes the specified contacts and returns the outcome in the same response | +| `webex cc contact-number delete` | `DELETE /organization/{orgid}/contact-number/{id}` | Delete an existing Contact Number by ID in a given organization. | +| `webex cc contact-number get` | `GET /organization/{orgid}/contact-number/{id}` | Retrieve an existing Contact Number by ID in a given organization. | +| `webex cc contact-number update` | `PUT /organization/{orgid}/contact-number/{id}` | Update an existing Contact Number by ID in a given organization. | +| `webex cc contact-service-queue delete` | `DELETE /organization/{orgid}/contact-service-queue/{id}` | Delete an existing Contact Service Queue by ID in a given organization. | | `webex cc contact-service-queue delete-references` | `POST /organization/{orgid}/contact-service-queue/delete-reference` | Removes the references to the specified entities (such as teams, sites, or agents) from Contact Service Queues for a given organization. | +| `webex cc contact-service-queue get` | `GET /organization/{orgid}/v2/contact-service-queue/{id}` | Retrieve an existing Contact Service Queue by ID in a given organization. | | `webex cc contact-service-queue list-by-dynamic-skills` | `POST /organization/{orgid}/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile` | Retrieve a list of skill-based Contact Service Queues that match the given dynamic skills and skill profile criteria in a given organization. | | `webex cc contact-service-queue list-by-skill-profile` | `GET /organization/{orgid}/contact-service-queue/by-skill-profile-id/{id}` | Retrieve a list of skill-based Contact Service Queues associated with a given skill profile ID, accessible to authorized clients in a given organization. | | `webex cc contact-service-queue list-by-user-skill-profile` | `POST /organization/{orgid}/contact-service-queue/fetch-by-userId-skillProfileId` | Retrieve a list of skill-based Contact Service Queues associated with the given skill profile ID and user ID combination in a given organization. | | `webex cc contact-service-queue list-manually-assignable` | `POST /organization/{orgid}/contact-service-queue/fetch-manually-assignable-queues` | Retrieve a list of Contact Service Queues that are eligible for manual contact assignment based on the provided criteria in a given organization. | | `webex cc contact-service-queue list-references` | `GET /organization/{orgid}/contact-service-queue/{id}/incoming-references` | Retrieve a list of all entities that have reference to an existing Contact Service Queue by ID in a given organization. | +| `webex cc contact-service-queue update` | `PUT /organization/{orgid}/v2/contact-service-queue/{id}` | Update an existing Contact Service Queue by ID in a given organization. | +| `webex cc desktop-layout delete` | `DELETE /organization/{orgid}/desktop-layout/{id}` | Delete an existing Desktop Layout by ID in a given organization. | +| `webex cc desktop-layout get` | `GET /organization/{orgid}/desktop-layout/{id}` | Retrieve an existing Desktop Layout by ID in a given organization. | +| `webex cc desktop-layout update` | `PUT /organization/{orgid}/desktop-layout/{id}` | Update an existing Desktop Layout by ID in a given organization. | +| `webex cc desktop-profile delete` | `DELETE /organization/{orgid}/agent-profile/{id}` | Delete an existing Desktop Profile by ID in a given organization. | +| `webex cc desktop-profile get` | `GET /organization/{orgid}/agent-profile/{id}` | Retrieve an existing Desktop Profile by ID in a given organization. | +| `webex cc desktop-profile update` | `PUT /organization/{orgid}/agent-profile/{id}` | Update an existing Desktop Profile by ID in a given organization. | +| `webex cc dial-plan delete` | `DELETE /organization/{orgid}/dial-plan/{id}` | Delete an existing Dial Plan by ID in a given organization. | +| `webex cc dial-plan get` | `GET /organization/{orgid}/dial-plan/{id}` | Retrieve an existing Dial Plan by ID in a given organization. | +| `webex cc dial-plan update` | `PUT /organization/{orgid}/dial-plan/{id}` | Update an existing Dial Plan by ID in a given organization. | +| `webex cc entry-point delete` | `DELETE /organization/{orgid}/entry-point/{id}` | Delete an existing Entry Point by ID in a given organization. | +| `webex cc entry-point get` | `GET /organization/{orgid}/entry-point/{id}` | Retrieve an existing Entry Point by ID in a given organization. | +| `webex cc entry-point update` | `PUT /organization/{orgid}/entry-point/{id}` | Update an existing Entry Point by ID in a given organization. | | `webex cc events list-specifications` | `GET /{orgId}/project/{projectId}/v2/event-specifications` | List the event types available for use in `event_flows[]` | | `webex cc external-data-updates update-task-global-variables` | `PUT /v1/data/updateExternal` | Updates numeric global variable values associated with a completed Webex Contact Center task | | `webex cc flow delete` | `DELETE /{orgId}/project/{projectId}/flows/{flowId}` | Permanently deletes a flow or subflow | @@ -106,15 +141,47 @@ Counts cover the normalized spec; handwritten commands and codegen exclusions ca | `webex cc functions test` | `POST /v1/{orgId}/functions/{id}:test` | Execute a custom function with a test payload | | `webex cc functions unlock` | `POST /v1/{orgId}/functions/{id}:unlock` | Release the edit lock on a custom function so that other users can edit it. | | `webex cc functions update` | `PUT /v1/{orgId}/functions/{id}` | Update an existing custom function by ID | +| `webex cc generated-summaries get` | `GET /organization/{orgid}/generated-summaries/{id}` | Retrieve an existing Generated Summaries resource by ID in a given organization | +| `webex cc generated-summaries update` | `PUT /organization/{orgid}/generated-summaries/{id}` | Update an existing Generated Summaries resource by ID in a given organization | +| `webex cc global-variables delete` | `DELETE /organization/{orgid}/cad-variable/{id}` | Delete an existing Global Variable by ID in a given organization. | +| `webex cc global-variables get` | `GET /organization/{orgid}/cad-variable/{id}` | Retrieve an existing Global Variable by ID in a given organization. | +| `webex cc global-variables update` | `PUT /organization/{orgid}/cad-variable/{id}` | Update an existing Global Variable by ID in a given organization | +| `webex cc holiday-list delete` | `DELETE /organization/{orgid}/holiday-list/{id}` | Delete an existing Holiday List by ID in a given organization. | +| `webex cc holiday-list get` | `GET /organization/{orgid}/holiday-list/{id}` | Retrieve an existing Holiday List by ID in a given organization. | +| `webex cc holiday-list update` | `PUT /organization/{orgid}/holiday-list/{id}` | Update an existing Holiday List by ID in a given organization. | +| `webex cc multimedia-profile delete` | `DELETE /organization/{orgid}/multimedia-profile/{id}` | Delete an existing Multimedia Profile by ID in a given organization. | +| `webex cc multimedia-profile get` | `GET /organization/{orgid}/multimedia-profile/{id}` | Retrieve an existing Multimedia Profile by ID in a given organization. | +| `webex cc multimedia-profile update` | `PUT /organization/{orgid}/multimedia-profile/{id}` | Update an existing Multimedia Profile by ID in a given organization. | | `webex cc outdial-ani bulk-save-entries` | `POST /organization/{orgid}/outdial-ani/{outDialAniId}/entry/bulk` | Create, Update or delete Outdial ANI Entries in bulk for an Address Book in a given organization. | +| `webex cc outdial-ani delete` | `DELETE /organization/{orgid}/outdial-ani/{id}` | Delete an existing Outdial ANI by ID in a given organization. | +| `webex cc outdial-ani get` | `GET /organization/{orgid}/outdial-ani/{id}` | Retrieve an existing Outdial ANI by ID in a given organization. | | `webex cc outdial-ani list-entries` | `GET /organization/{orgid}/outdial-ani/entry` | Retrieve a list of Outdial ANI Entries in a given organization. | | `webex cc outdial-ani list-entries-for-ani` | `GET /organization/{orgid}/v2/outdial-ani/{outDialAniId}/entry` | Retrieve a list of Outdial ANI Entries in a given organization. | +| `webex cc outdial-ani update` | `PUT /organization/{orgid}/outdial-ani/{id}` | Update an existing Outdial ANI by ID in a given organization. | +| `webex cc overrides delete` | `DELETE /organization/{orgid}/overrides/{id}` | Delete an existing Overrides resource by ID in a given organization. | +| `webex cc overrides get` | `GET /organization/{orgid}/overrides/{id}` | Retrieve an existing Overrides resource by ID in a given organization. | +| `webex cc overrides update` | `PUT /organization/{orgid}/overrides/{id}` | Update an existing Overrides resource by ID in a given organization. | +| `webex cc resource-collection delete` | `DELETE /organization/{orgid}/resource-collection/{id}` | Delete an existing resource collection by ID in a given organization. | +| `webex cc resource-collection get` | `GET /organization/{orgid}/resource-collection/{id}` | Retrieve an existing Resource Collection by ID in a given organization. | +| `webex cc resource-collection update` | `PUT /organization/{orgid}/resource-collection/{id}` | Update an existing resource collection by ID in a given organization. | | `webex cc search-metadata get` | `GET /search/v2/meta` | Returns schema metadata for the Webex Contact Center Search GraphQL API, describing supported queries, fields, nested structures, data types, filters, sorting options, grouping capabilities, and aggregation operations. | +| `webex cc site delete` | `DELETE /organization/{orgid}/site/{id}` | Delete an existing Site by ID in a given organization. | +| `webex cc site get` | `GET /organization/{orgid}/site/{id}` | Retrieve an existing Site by ID in a given organization. | +| `webex cc site update` | `PUT /organization/{orgid}/site/{id}` | Update an existing Site by ID in a given organization. | +| `webex cc skill delete` | `DELETE /organization/{orgid}/skill/{id}` | Delete an existing Skill by ID in a given organization. | +| `webex cc skill get` | `GET /organization/{orgid}/skill/{id}` | Retrieve an existing Skill by ID in a given organization. | +| `webex cc skill update` | `PUT /organization/{orgid}/skill/{id}` | Update an existing Skill by ID in a given organization. | +| `webex cc skill-profile delete` | `DELETE /organization/{orgid}/skill-profile/{id}` | Delete an existing Skill Profile by ID in a given organization. | +| `webex cc skill-profile get` | `GET /organization/{orgid}/skill-profile/{id}` | Retrieve an existing Skill Profile by ID in a given organization. | +| `webex cc skill-profile update` | `PUT /organization/{orgid}/skill-profile/{id}` | Update an existing Skill Profile by ID in a given organization. | | `webex cc tasks append-message` | `POST /v2/tasks/{taskId}/messages` | This feature is currently in Beta | | `webex cc tasks drop-participant-conference` | `POST /v1/tasks/{taskId}/conference/participants/{participantId}/drop` | Access this endpoint when the user needs to drop a specific participant from an active conference associated with a task | | `webex cc tasks pause-digital` | `POST /v1/tasks/{taskId}/pause` | Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to pause a task that cannot be handled immediately | | `webex cc tasks resume-digital` | `POST /v1/tasks/{taskId}/resume` | Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to resume a previously paused task | | `webex cc tasks unhold` | `POST /v1/tasks/{taskId}/unhold` | Access this endpoint when the user has to resume a call from hold | +| `webex cc team delete` | `DELETE /organization/{orgid}/team/{id}` | Delete an existing Team by ID in a given organization. | +| `webex cc team get` | `GET /organization/{orgid}/team/{id}` | Retrieve an existing Team by ID in a given organization. | +| `webex cc team update` | `PUT /organization/{orgid}/team/{id}` | Update an existing Team by ID in a given organization. | | `webex cc templates get-flow` | `GET /templates/{id}` | Retrieve a specific flow template by its ID | | `webex cc templates list-flow` | `GET /templates` | List available flow templates that can be used to create new flows. | | `webex cc usage-reports create` | `POST /v1/usage-reports` | Creates a new usage report for the specified organization, resource type, | @@ -123,9 +190,18 @@ Counts cover the normalized spec; handwritten commands and codegen exclusions ca | `webex cc usage-reports get` | `GET /v1/usage-reports/{reportId}` | Retrieves detailed information for a specific usage report. | | `webex cc usage-reports list` | `GET /v1/usage-reports` | Retrieves a list of usage reports for the organization | | `webex cc usage-reports list-resource-types` | `GET /v1/usage-reports/resource-types` | Returns the list of available resource types that can be used for report generation, along with available data dates. | +| `webex cc user-profiles delete` | `DELETE /organization/{orgid}/v3/user-profile/{id}` | Delete an existing user profile by ID in a given organization. | +| `webex cc user-profiles get` | `GET /organization/{orgid}/v3/user-profile/{id}` | Retrieve an existing user profile by ID in a given organization. | +| `webex cc user-profiles update` | `PUT /organization/{orgid}/v3/user-profile/{id}` | Update an existing user profile by ID in a given organization. | | `webex cc users bulk-partial-update-dynamic-skills` | `PATCH /organization/{orgid}/user/bulk/update-dynamic-skill/{skillId}` | Assign or unassign a dynamic skill to/from multiple users in bulk for a given organization. | +| `webex cc users get` | `GET /organization/{orgid}/user/{id}` | Retrieve an existing Users by ID in a given organization. | | `webex cc users list-by-ids` | `POST /organization/{orgid}/user/fetch-user-details-by-ids` | Retrieve an existing User's first name, last name and email by list of IDs in a given organization. | | `webex cc users list-call-monitoring-id` | `GET /organization/{orgid}/user/by-call-monitoring-id/{id}` | Fetch paginated users associated to the selected call monitoring team filters while enforcing team ACL. | +| `webex cc users patch` | `PATCH /organization/{orgid}/user/{id}` | Partially update User by ID in a given organization. | +| `webex cc users update` | `PUT /organization/{orgid}/user/{id}` | Update an existing User by ID in a given organization. | +| `webex cc work-types delete` | `DELETE /organization/{orgid}/work-type/{id}` | Delete an existing Work Type by ID in a given organization. | +| `webex cc work-types get` | `GET /organization/{orgid}/work-type/{id}` | Retrieve an existing Work Type by ID in a given organization. | +| `webex cc work-types update` | `PUT /organization/{orgid}/work-type/{id}` | Update an existing Work Type by ID in a given organization. | ### Existing names with changed routes @@ -141,25 +217,101 @@ Counts cover the normalized spec; handwritten commands and codegen exclusions ca | Previous command | Status | | --- | --- | +| `webex cc address-book delete-id` | Alias for `webex cc address-book delete` | +| `webex cc address-book get-id` | Alias for `webex cc address-book get` | +| `webex cc address-book update-id` | Alias for `webex cc address-book update` | | `webex cc agent-personal-greeting-files create-v2-api` | Alias for `webex cc agent-personal-greeting-files create` | -| `webex cc agent-personal-greeting-files delete-id-v2-api` | Alias for `webex cc agent-personal-greeting-files delete-id` | +| `webex cc agent-personal-greeting-files delete-id-v2-api` | Alias for `webex cc agent-personal-greeting-files delete` | | `webex cc agent-personal-greeting-files delete-references-1` | Alias for `webex cc agent-personal-greeting-files delete-references` | -| `webex cc agent-personal-greeting-files get-id-v2-api` | Alias for `webex cc agent-personal-greeting-files get-id` | -| `webex cc agent-personal-greeting-files patch-id-v2-api` | Alias for `webex cc agent-personal-greeting-files patch-id` | -| `webex cc agent-personal-greeting-files update-id-v2-api` | Alias for `webex cc agent-personal-greeting-files update-id` | +| `webex cc agent-personal-greeting-files get-id-v2-api` | Alias for `webex cc agent-personal-greeting-files get` | +| `webex cc agent-personal-greeting-files patch-id-v2-api` | Alias for `webex cc agent-personal-greeting-files patch` | +| `webex cc agent-personal-greeting-files update-id-v2-api` | Alias for `webex cc agent-personal-greeting-files update` | +| `webex cc ai-feature get-id` | Alias for `webex cc ai-feature get` | +| `webex cc ai-feature patch-id` | Alias for `webex cc ai-feature patch` | +| `webex cc audio-files delete-id` | Alias for `webex cc audio-files delete` | +| `webex cc audio-files get-id` | Alias for `webex cc audio-files get` | +| `webex cc audio-files patch-id` | Alias for `webex cc audio-files patch` | +| `webex cc audio-files update-id` | Alias for `webex cc audio-files update` | +| `webex cc auto-csat get-id` | Alias for `webex cc auto-csat get` | +| `webex cc auto-csat update-id` | Alias for `webex cc auto-csat update` | +| `webex cc auxiliary-code delete-id` | Alias for `webex cc auxiliary-code delete` | +| `webex cc auxiliary-code get-id` | Alias for `webex cc auxiliary-code get` | +| `webex cc auxiliary-code update-id` | Alias for `webex cc auxiliary-code update` | +| `webex cc business-hour delete-id` | Alias for `webex cc business-hour delete` | +| `webex cc business-hour get-id` | Alias for `webex cc business-hour get` | +| `webex cc business-hour update-id` | Alias for `webex cc business-hour update` | +| `webex cc contact-number delete-id` | Alias for `webex cc contact-number delete` | +| `webex cc contact-number get-id` | Alias for `webex cc contact-number get` | +| `webex cc contact-number update-id` | Alias for `webex cc contact-number update` | | `webex cc contact-service-queue delete-csq-references` | Alias for `webex cc contact-service-queue delete-references` | +| `webex cc contact-service-queue delete-id` | Alias for `webex cc contact-service-queue delete` | +| `webex cc contact-service-queue get-id` | Alias for `webex cc contact-service-queue get` | | `webex cc contact-service-queue list-csq-references-id` | Alias for `webex cc contact-service-queue list-references` | | `webex cc contact-service-queue list-csqs-skills-profile` | Alias for `webex cc contact-service-queue list-by-dynamic-skills` | | `webex cc contact-service-queue list-csqs-user-profile` | Alias for `webex cc contact-service-queue list-by-user-skill-profile` | | `webex cc contact-service-queue list-manually-assignable-csqs` | Alias for `webex cc contact-service-queue list-manually-assignable` | | `webex cc contact-service-queue list-skill-csqs-skill-profile` | Alias for `webex cc contact-service-queue list-by-skill-profile` | +| `webex cc contact-service-queue update-id` | Alias for `webex cc contact-service-queue update` | +| `webex cc desktop-layout delete-id` | Alias for `webex cc desktop-layout delete` | +| `webex cc desktop-layout get-id` | Alias for `webex cc desktop-layout get` | +| `webex cc desktop-layout update-id` | Alias for `webex cc desktop-layout update` | +| `webex cc desktop-profile delete-id` | Alias for `webex cc desktop-profile delete` | +| `webex cc desktop-profile get-id` | Alias for `webex cc desktop-profile get` | +| `webex cc desktop-profile update-id` | Alias for `webex cc desktop-profile update` | +| `webex cc dial-plan delete-id` | Alias for `webex cc dial-plan delete` | +| `webex cc dial-plan get-id` | Alias for `webex cc dial-plan get` | +| `webex cc dial-plan update-id` | Alias for `webex cc dial-plan update` | +| `webex cc entry-point delete-id` | Alias for `webex cc entry-point delete` | +| `webex cc entry-point get-id` | Alias for `webex cc entry-point get` | +| `webex cc entry-point update-id` | Alias for `webex cc entry-point update` | +| `webex cc generated-summaries get-id` | Alias for `webex cc generated-summaries get` | +| `webex cc generated-summaries update-id` | Alias for `webex cc generated-summaries update` | +| `webex cc global-variables delete-id` | Alias for `webex cc global-variables delete` | +| `webex cc global-variables get-id` | Alias for `webex cc global-variables get` | +| `webex cc global-variables update-id` | Alias for `webex cc global-variables update` | +| `webex cc holiday-list delete-id` | Alias for `webex cc holiday-list delete` | +| `webex cc holiday-list get-id` | Alias for `webex cc holiday-list get` | +| `webex cc holiday-list update-id` | Alias for `webex cc holiday-list update` | +| `webex cc multimedia-profile delete-id` | Alias for `webex cc multimedia-profile delete` | +| `webex cc multimedia-profile get-id` | Alias for `webex cc multimedia-profile get` | +| `webex cc multimedia-profile update-id` | Alias for `webex cc multimedia-profile update` | | `webex cc outdial-ani bulk-save-entry` | Alias for `webex cc outdial-ani bulk-save-entries` | +| `webex cc outdial-ani delete-id` | Alias for `webex cc outdial-ani delete` | +| `webex cc outdial-ani get-id` | Alias for `webex cc outdial-ani get` | | `webex cc outdial-ani list-entry` | Alias for `webex cc outdial-ani list-entries` | | `webex cc outdial-ani list-entry-2` | Alias for `webex cc outdial-ani list-entries-for-ani` | +| `webex cc outdial-ani update-id` | Alias for `webex cc outdial-ani update` | +| `webex cc overrides delete-id` | Alias for `webex cc overrides delete` | +| `webex cc overrides get-id` | Alias for `webex cc overrides get` | +| `webex cc overrides update-id` | Alias for `webex cc overrides update` | +| `webex cc resource-collection delete-id` | Alias for `webex cc resource-collection delete` | +| `webex cc resource-collection get-id` | Alias for `webex cc resource-collection get` | +| `webex cc resource-collection update-id` | Alias for `webex cc resource-collection update` | +| `webex cc site delete-id` | Alias for `webex cc site delete` | +| `webex cc site get-id` | Alias for `webex cc site get` | +| `webex cc site update-id` | Alias for `webex cc site update` | +| `webex cc skill delete-id` | Alias for `webex cc skill delete` | +| `webex cc skill get-id` | Alias for `webex cc skill get` | +| `webex cc skill update-id` | Alias for `webex cc skill update` | +| `webex cc skill-profile delete-id` | Alias for `webex cc skill-profile delete` | +| `webex cc skill-profile get-id` | Alias for `webex cc skill-profile get` | +| `webex cc skill-profile update-id` | Alias for `webex cc skill-profile update` | | `webex cc tasks resume` | Alias for `webex cc tasks unhold` | | `webex cc tasks update-2` | Alias for `webex cc tasks append-message` | +| `webex cc team delete-id` | Alias for `webex cc team delete` | +| `webex cc team get-id` | Alias for `webex cc team get` | +| `webex cc team update-id` | Alias for `webex cc team update` | +| `webex cc user-profiles delete-id` | Alias for `webex cc user-profiles delete` | +| `webex cc user-profiles get-id` | Alias for `webex cc user-profiles get` | +| `webex cc user-profiles update-id` | Alias for `webex cc user-profiles update` | | `webex cc users bulk-update-dynamic-skills` | Alias for `webex cc users bulk-partial-update-dynamic-skills` | +| `webex cc users get-id` | Alias for `webex cc users get` | | `webex cc users get-ids` | Alias for `webex cc users list-by-ids` | +| `webex cc users patch-id` | Alias for `webex cc users patch` | +| `webex cc users update-id` | Alias for `webex cc users update` | +| `webex cc work-types delete-id` | Alias for `webex cc work-types delete` | +| `webex cc work-types get-id` | Alias for `webex cc work-types get` | +| `webex cc work-types update-id` | Alias for `webex cc work-types update` | ## meetings diff --git a/codegen/NAMING.md b/codegen/NAMING.md index ef1065a..29d1fcf 100644 --- a/codegen/NAMING.md +++ b/codegen/NAMING.md @@ -6,7 +6,7 @@ Every row gives the full previous command, its current canonical command, what t **Flow formats:** `flow import`/`export` use the current typed flow document; `import-legacy`/`export-legacy` use deprecated raw FDL. This intentionally changes the format of the pre-refresh unsuffixed commands. Current flow, activity, event, and template commands use unprefixed URLs. Duplicate prefixed commands and the temporary `-direct` names have been removed. -This reference contains **94 previous-to-current mappings**. Commands whose names and groups did not change are omitted. +The refresh tables below contain **94 previous-to-current mappings**, followed by **88 ID-suffix mappings**. Commands whose names and groups did not change are omitted. ## calling call-controls-for-me @@ -38,10 +38,10 @@ This reference contains **94 previous-to-current mappings**. Commands whose name | --- | --- | --- | --- | --- | | `webex cc agent-personal-greeting-files create-v2-api` | Before refresh | `webex cc agent-personal-greeting-files create` | Create a new Greeting File in a given organization. | Yes — alias | | `webex cc agent-personal-greeting-files delete-references-1` | Before refresh | `webex cc agent-personal-greeting-files delete-references` | Removes all references of the specified agent (ciUserId) from greeting files in the given organization. | Yes — alias | -| `webex cc agent-personal-greeting-files get-id-v2-api` | Before refresh | `webex cc agent-personal-greeting-files get-id` | Retrieve an existing Greeting File by ID in a given organization. | Yes — alias | -| `webex cc agent-personal-greeting-files update-id-v2-api` | Before refresh | `webex cc agent-personal-greeting-files update-id` | Update an existing Greeting File by ID in a given organization. | Yes — alias | -| `webex cc agent-personal-greeting-files delete-id-v2-api` | Before refresh | `webex cc agent-personal-greeting-files delete-id` | Delete an existing Greeting File by ID in a given organization. | Yes — alias | -| `webex cc agent-personal-greeting-files patch-id-v2-api` | Before refresh | `webex cc agent-personal-greeting-files patch-id` | Partially update Greeting File by ID in a given organization. | Yes — alias | +| `webex cc agent-personal-greeting-files get-id-v2-api` | Before refresh | `webex cc agent-personal-greeting-files get` | Retrieve an existing Greeting File by ID in a given organization. | Yes — alias | +| `webex cc agent-personal-greeting-files update-id-v2-api` | Before refresh | `webex cc agent-personal-greeting-files update` | Update an existing Greeting File by ID in a given organization. | Yes — alias | +| `webex cc agent-personal-greeting-files delete-id-v2-api` | Before refresh | `webex cc agent-personal-greeting-files delete` | Delete an existing Greeting File by ID in a given organization. | Yes — alias | +| `webex cc agent-personal-greeting-files patch-id-v2-api` | Before refresh | `webex cc agent-personal-greeting-files patch` | Partially update Greeting File by ID in a given organization. | Yes — alias | ## cc contact-service-queue @@ -208,8 +208,103 @@ Created draft `CLI_Route_Test_ce61ca68ca8b` (ID `6abc548b79b443250d35110c`) usin These checks establish that both URL forms act on the same flow and support the tested draft lifecycle in Cloverhound. The unprefixed URLs are sufficient for those current-format operations; separate prefixed command variants provide no demonstrated additional capability. Publish and legacy import/export were not exercised in this write test. Keep legacy-format commands distinct from current-format commands regardless of URL-prefix consolidation. +## Redundant ID suffixes + +The ID remains a parameter: `get --id`, `delete --id`, `patch --id`, and `update --id`. All six API areas were checked; current matches are in Contact Center. The old names remain compatibility aliases, including earlier versioned aliases. Qualifiers such as `get-ci-id` remain because they distinguish another lookup. + +| Previous full command | Current full command | Purpose | Old name supported? | +| --- | --- | --- | --- | +| `webex cc auto-csat get-id` | `webex cc auto-csat get` | Retrieve an existing Auto CSAT resource by ID in a given organization | Yes | +| `webex cc auto-csat update-id` | `webex cc auto-csat update` | Update an existing Auto CSAT resource by ID in a given organization | Yes | +| `webex cc generated-summaries get-id` | `webex cc generated-summaries get` | Retrieve an existing Generated Summaries resource by ID in a given organization | Yes | +| `webex cc generated-summaries update-id` | `webex cc generated-summaries update` | Update an existing Generated Summaries resource by ID in a given organization | Yes | +| `webex cc business-hour get-id` | `webex cc business-hour get` | Retrieve an existing Business Hours resource by ID in a given organization. | Yes | +| `webex cc business-hour update-id` | `webex cc business-hour update` | Update an existing Business Hours resource by ID in a given organization. | Yes | +| `webex cc business-hour delete-id` | `webex cc business-hour delete` | Delete an existing Business Hours resource by ID in a given organization. | Yes | +| `webex cc holiday-list get-id` | `webex cc holiday-list get` | Retrieve an existing Holiday List by ID in a given organization. | Yes | +| `webex cc holiday-list update-id` | `webex cc holiday-list update` | Update an existing Holiday List by ID in a given organization. | Yes | +| `webex cc holiday-list delete-id` | `webex cc holiday-list delete` | Delete an existing Holiday List by ID in a given organization. | Yes | +| `webex cc overrides get-id` | `webex cc overrides get` | Retrieve an existing Overrides resource by ID in a given organization. | Yes | +| `webex cc overrides update-id` | `webex cc overrides update` | Update an existing Overrides resource by ID in a given organization. | Yes | +| `webex cc overrides delete-id` | `webex cc overrides delete` | Delete an existing Overrides resource by ID in a given organization. | Yes | +| `webex cc address-book get-id` | `webex cc address-book get` | Retrieve an existing Address Book by ID in a given organization. | Yes | +| `webex cc address-book update-id` | `webex cc address-book update` | Update an existing Address Book by ID in a given organization. | Yes | +| `webex cc address-book delete-id` | `webex cc address-book delete` | Delete an existing Address Book by ID in a given organization. | Yes | +| `webex cc audio-files get-id` | `webex cc audio-files get` | Retrieve an existing Audio File by ID in a given organization. | Yes | +| `webex cc audio-files update-id` | `webex cc audio-files update` | Update an existing Audio File by ID in a given organization. | Yes | +| `webex cc audio-files delete-id` | `webex cc audio-files delete` | Delete an existing Audio File by ID in a given organization. | Yes | +| `webex cc audio-files patch-id` | `webex cc audio-files patch` | Partially update Audio File by ID in a given organization. | Yes | +| `webex cc auxiliary-code get-id` | `webex cc auxiliary-code get` | Retrieve an existing Auxiliary Code by ID in a given organization. | Yes | +| `webex cc auxiliary-code update-id` | `webex cc auxiliary-code update` | Update an existing Auxiliary Code by ID in a given organization. | Yes | +| `webex cc auxiliary-code delete-id` | `webex cc auxiliary-code delete` | Delete an existing Auxiliary Code by ID in a given organization. | Yes | +| `webex cc contact-number get-id` | `webex cc contact-number get` | Retrieve an existing Contact Number by ID in a given organization. | Yes | +| `webex cc contact-number update-id` | `webex cc contact-number update` | Update an existing Contact Number by ID in a given organization. | Yes | +| `webex cc contact-number delete-id` | `webex cc contact-number delete` | Delete an existing Contact Number by ID in a given organization. | Yes | +| `webex cc contact-service-queue get-id` | `webex cc contact-service-queue get` | Retrieve an existing Contact Service Queue by ID in a given organization. | Yes | +| `webex cc contact-service-queue update-id` | `webex cc contact-service-queue update` | Update an existing Contact Service Queue by ID in a given organization. | Yes | +| `webex cc contact-service-queue delete-id` | `webex cc contact-service-queue delete` | Delete an existing Contact Service Queue by ID in a given organization. | Yes | +| `webex cc desktop-layout get-id` | `webex cc desktop-layout get` | Retrieve an existing Desktop Layout by ID in a given organization. | Yes | +| `webex cc desktop-layout update-id` | `webex cc desktop-layout update` | Update an existing Desktop Layout by ID in a given organization. | Yes | +| `webex cc desktop-layout delete-id` | `webex cc desktop-layout delete` | Delete an existing Desktop Layout by ID in a given organization. | Yes | +| `webex cc desktop-profile get-id` | `webex cc desktop-profile get` | Retrieve an existing Desktop Profile by ID in a given organization. | Yes | +| `webex cc desktop-profile update-id` | `webex cc desktop-profile update` | Update an existing Desktop Profile by ID in a given organization. | Yes | +| `webex cc desktop-profile delete-id` | `webex cc desktop-profile delete` | Delete an existing Desktop Profile by ID in a given organization. | Yes | +| `webex cc dial-plan get-id` | `webex cc dial-plan get` | Retrieve an existing Dial Plan by ID in a given organization. | Yes | +| `webex cc dial-plan update-id` | `webex cc dial-plan update` | Update an existing Dial Plan by ID in a given organization. | Yes | +| `webex cc dial-plan delete-id` | `webex cc dial-plan delete` | Delete an existing Dial Plan by ID in a given organization. | Yes | +| `webex cc entry-point get-id` | `webex cc entry-point get` | Retrieve an existing Entry Point by ID in a given organization. | Yes | +| `webex cc entry-point update-id` | `webex cc entry-point update` | Update an existing Entry Point by ID in a given organization. | Yes | +| `webex cc entry-point delete-id` | `webex cc entry-point delete` | Delete an existing Entry Point by ID in a given organization. | Yes | +| `webex cc global-variables get-id` | `webex cc global-variables get` | Retrieve an existing Global Variable by ID in a given organization. | Yes | +| `webex cc global-variables update-id` | `webex cc global-variables update` | Update an existing Global Variable by ID in a given organization | Yes | +| `webex cc global-variables delete-id` | `webex cc global-variables delete` | Delete an existing Global Variable by ID in a given organization. | Yes | +| `webex cc multimedia-profile get-id` | `webex cc multimedia-profile get` | Retrieve an existing Multimedia Profile by ID in a given organization. | Yes | +| `webex cc multimedia-profile update-id` | `webex cc multimedia-profile update` | Update an existing Multimedia Profile by ID in a given organization. | Yes | +| `webex cc multimedia-profile delete-id` | `webex cc multimedia-profile delete` | Delete an existing Multimedia Profile by ID in a given organization. | Yes | +| `webex cc outdial-ani get-id` | `webex cc outdial-ani get` | Retrieve an existing Outdial ANI by ID in a given organization. | Yes | +| `webex cc outdial-ani update-id` | `webex cc outdial-ani update` | Update an existing Outdial ANI by ID in a given organization. | Yes | +| `webex cc outdial-ani delete-id` | `webex cc outdial-ani delete` | Delete an existing Outdial ANI by ID in a given organization. | Yes | +| `webex cc site get-id` | `webex cc site get` | Retrieve an existing Site by ID in a given organization. | Yes | +| `webex cc site update-id` | `webex cc site update` | Update an existing Site by ID in a given organization. | Yes | +| `webex cc site delete-id` | `webex cc site delete` | Delete an existing Site by ID in a given organization. | Yes | +| `webex cc skill get-id` | `webex cc skill get` | Retrieve an existing Skill by ID in a given organization. | Yes | +| `webex cc skill update-id` | `webex cc skill update` | Update an existing Skill by ID in a given organization. | Yes | +| `webex cc skill delete-id` | `webex cc skill delete` | Delete an existing Skill by ID in a given organization. | Yes | +| `webex cc skill-profile get-id` | `webex cc skill-profile get` | Retrieve an existing Skill Profile by ID in a given organization. | Yes | +| `webex cc skill-profile update-id` | `webex cc skill-profile update` | Update an existing Skill Profile by ID in a given organization. | Yes | +| `webex cc skill-profile delete-id` | `webex cc skill-profile delete` | Delete an existing Skill Profile by ID in a given organization. | Yes | +| `webex cc team get-id` | `webex cc team get` | Retrieve an existing Team by ID in a given organization. | Yes | +| `webex cc team update-id` | `webex cc team update` | Update an existing Team by ID in a given organization. | Yes | +| `webex cc team delete-id` | `webex cc team delete` | Delete an existing Team by ID in a given organization. | Yes | +| `webex cc user-profiles get-id` | `webex cc user-profiles get` | Retrieve an existing user profile by ID in a given organization. | Yes | +| `webex cc user-profiles update-id` | `webex cc user-profiles update` | Update an existing user profile by ID in a given organization. | Yes | +| `webex cc user-profiles delete-id` | `webex cc user-profiles delete` | Delete an existing user profile by ID in a given organization. | Yes | +| `webex cc users get-id` | `webex cc users get` | Retrieve an existing Users by ID in a given organization. | Yes | +| `webex cc users update-id` | `webex cc users update` | Update an existing User by ID in a given organization. | Yes | +| `webex cc users patch-id` | `webex cc users patch` | Partially update User by ID in a given organization. | Yes | +| `webex cc work-types get-id` | `webex cc work-types get` | Retrieve an existing Work Type by ID in a given organization. | Yes | +| `webex cc work-types update-id` | `webex cc work-types update` | Update an existing Work Type by ID in a given organization. | Yes | +| `webex cc work-types delete-id` | `webex cc work-types delete` | Delete an existing Work Type by ID in a given organization. | Yes | +| `webex cc ai-feature get-id` | `webex cc ai-feature get` | Retrieve an existing AI Feature resource by ID in a given organization. | Yes | +| `webex cc ai-feature patch-id` | `webex cc ai-feature patch` | Partially update AI Feature resource by ID in a given organization. | Yes | +| `webex cc agent-personal-greeting-files get-id` | `webex cc agent-personal-greeting-files get` | Retrieve an existing Greeting File by ID in a given organization. | Yes | +| `webex cc agent-personal-greeting-files update-id` | `webex cc agent-personal-greeting-files update` | Update an existing Greeting File by ID in a given organization. | Yes | +| `webex cc agent-personal-greeting-files delete-id` | `webex cc agent-personal-greeting-files delete` | Delete an existing Greeting File by ID in a given organization. | Yes | +| `webex cc agent-personal-greeting-files patch-id` | `webex cc agent-personal-greeting-files patch` | Partially update Greeting File by ID in a given organization. | Yes | +| `webex cc resource-collection get-id` | `webex cc resource-collection get` | Retrieve an existing Resource Collection by ID in a given organization. | Yes | +| `webex cc resource-collection update-id` | `webex cc resource-collection update` | Update an existing resource collection by ID in a given organization. | Yes | +| `webex cc resource-collection delete-id` | `webex cc resource-collection delete` | Delete an existing resource collection by ID in a given organization. | Yes | +| `webex cc asset get-id` | `webex cc asset get` | Retrieve an existing Asset by ID in a given organization | Yes | +| `webex cc asset update-id` | `webex cc asset update` | Update an existing Asset by ID in a given organization | Yes | +| `webex cc asset delete-id` | `webex cc asset delete` | Delete an existing Asset by ID in a given organization | Yes | +| `webex cc asset patch-id` | `webex cc asset patch` | Partially update Asset by ID in a given organization | Yes | +| `webex cc channel get-id` | `webex cc channel get` | Retrieve an existing Channel by ID in a given organization | Yes | +| `webex cc channel update-id` | `webex cc channel update` | Update an existing Channel by ID in a given organization. | Yes | +| `webex cc channel delete-id` | `webex cc channel delete` | Delete an existing Channel by ID in a given organization. | Yes | +| `webex cc channel patch-id` | `webex cc channel patch` | Partially update a channel by ID | Yes | + ## Maintaining this reference Duplicate prefixed entries are excluded through `SUPERSEDED_ROUTES` in `codegen/naming_overrides.py`. Each exclusion identifies a required replacement request; extraction fails if it disappears. The generator keeps the replacement’s complete request contract. Legacy import/export retain their prefixed routes. Publish uses the unprefixed route but was not live-tested. -Names and compatibility aliases are defined in `codegen/naming_overrides.py` and applied to the enriched spec before generating Go commands and skill references. Update the override table, run `make codegen`, and update this reference when changing a mapping. Handwritten request implementations continue to use `custom_*.go` and the generator skip lists. +Exact `get-id`, `delete-id`, `patch-id`, and `update-id` names are shortened centrally by `apply_naming_overrides` in `codegen/extract_api_spec.py`, with collision checks and old-name aliases. Route-specific names and compatibility aliases are defined in `codegen/naming_overrides.py` and applied to the enriched spec before generating Go commands and skill references. Update the override table, run `make codegen`, and update this reference when changing a mapping. Handwritten request implementations continue to use `custom_*.go` and the generator skip lists. diff --git a/codegen/extract_api_spec.py b/codegen/extract_api_spec.py index 8d1f8fc..728bf48 100644 --- a/codegen/extract_api_spec.py +++ b/codegen/extract_api_spec.py @@ -368,6 +368,7 @@ def merge_folders(folders): def apply_naming_overrides(collection_name, folders): """Resolve explicit naming exceptions and identical routes across merged groups.""" overrides = NAMING_OVERRIDES.get(collection_name, {}) + shortened_groups = set() superseded = SUPERSEDED_ROUTES.get(collection_name, {}) available = {(e['method'], e['path']) for f in folders for e in f['endpoints']} merged = {} @@ -384,6 +385,10 @@ def apply_naming_overrides(collection_name, folders): key, (source_group, ep['command'], ())) ep['command'] = command ep['aliases'] = list(aliases) + if command in ('get-id', 'delete-id', 'patch-id', 'update-id'): + ep['command'] = command[:-3] + ep['aliases'] = list(dict.fromkeys([command, *aliases])) + shortened_groups.add(group) target = merged.setdefault(group, { 'group': group, 'original_folders': [], 'endpoints': [], 'aliases': GROUP_ALIASES.get(collection_name, {}).get(group, []), @@ -402,7 +407,7 @@ def apply_naming_overrides(collection_name, folders): existing['aliases'].append(alias) continue target['endpoints'].append(ep) - changed_groups = {value[0] for value in overrides.values()} + changed_groups = {value[0] for value in overrides.values()} | shortened_groups for group in merged.values(): if group['group'] not in changed_groups: continue diff --git a/codegen/test_naming_overrides.py b/codegen/test_naming_overrides.py index b422fe9..6fbd821 100644 --- a/codegen/test_naming_overrides.py +++ b/codegen/test_naming_overrides.py @@ -47,6 +47,26 @@ def test_voice_resume_keeps_its_original_meaning(self): self.assertEqual(self.command(area, 'tasks', 'resume-digital')['path'], '/v1/tasks/{taskId}/resume') self.assertEqual(self.command(area, 'tasks', 'resume-recording')['path'], '/v1/tasks/{taskId}/record/resume') + def test_redundant_id_names_are_aliases_in_every_area(self): + for area in self.raw: + for group in self.resolved(area): + for ep in group['endpoints']: + self.assertNotIn(ep['command'], ('get-id', 'delete-id', 'patch-id', 'update-id')) + for group in self.raw[area]: + for ep in group['endpoints']: + if ep['command'] in ('get-id', 'delete-id', 'patch-id', 'update-id'): + result = self.command(area, group['group'], ep['command']) + self.assertEqual(result['path'], ep['path']) + self.assertEqual(result['command'], ep['command'][:-3]) + + def test_shortening_rejects_a_collision_instead_of_numbering(self): + folders = [{'group': 'example', 'original_folders': ['Example'], 'endpoints': [ + {'command': 'get-id', 'method': 'GET', 'path': '/example/{id}'}, + {'command': 'get', 'method': 'GET', 'path': '/different'}, + ]}] + with self.assertRaisesRegex(ValueError, 'Duplicate command or alias'): + apply_naming_overrides('Webex Admin', folders) + def test_flow_versions_and_routes_remain_distinct(self): area = 'Webex Contact Center' self.assertEqual(self.command(area, 'flow', 'import-legacy')['path'], diff --git a/site/src/content/docs/cc.mdx b/site/src/content/docs/cc.mdx index bc7e2e1..ee89549 100644 --- a/site/src/content/docs/cc.mdx +++ b/site/src/content/docs/cc.mdx @@ -81,16 +81,16 @@ The `webex cc` subcommand provides access to the Webex Contact Center API. The ` webex cc list # Get by ID -webex cc get-id --orgid "..." --id "..." +webex cc get --orgid "..." --id "..." # Create webex cc create --orgid "..." --body-file config.json # Update -webex cc update-id --orgid "..." --id "..." --body-file updated.json +webex cc update --orgid "..." --id "..." --body-file updated.json # Delete -webex cc delete-id --orgid "..." --id "..." +webex cc delete --orgid "..." --id "..." # List references (what depends on this resource) webex cc list-references --orgid "..." --id "..." diff --git a/skill/cc/SKILL.md b/skill/cc/SKILL.md index 605724a..46d374c 100644 --- a/skill/cc/SKILL.md +++ b/skill/cc/SKILL.md @@ -14,27 +14,27 @@ Alias: `webex contact-center ` | Resource | Common operations | |---|---| -| `site` | list, create, get-id, update-id, delete-id | -| `entry-point` | list, create, get-id, update-id, delete-id | -| `contact-service-queue` | list, create, get-id, update-id, delete-id | -| `team` | list, create, get-id, update-id, delete-id | -| `users` | list, get-id, get-along-profile-id, patch-id, update-id | +| `site` | list, create, get, update, delete | +| `entry-point` | list, create, get, update, delete | +| `contact-service-queue` | list, create, get, update, delete | +| `team` | list, create, get, update, delete | +| `users` | list, get, get-along-profile-id, patch, update | | `agents` | login, logout, state-change, get-activities, get-statistics | | `flow` | list, export, import, publish | -| `audio-files` | list, get-id, create, update-id, delete-id | -| `global-variables` | list, create, get-id, update-id, delete-id | -| `business-hour` | list, create, get-id, update-id, delete-id | -| `auxiliary-code` | list, create, get-id, update-id, delete-id | -| `desktop-profile` | list, create, get-id, update-id, delete-id | -| `desktop-layout` | list, create, get-id, update-id, delete-id | -| `skill` | list, create, get-id, update-id, delete-id | -| `skill-profile` | list, create, get-id, update-id, delete-id | -| `multimedia-profile` | list, create, get-id, update-id, delete-id | -| `dial-plan` | list, create, get-id, update-id, delete-id | -| `dial-number` | list, list-dialed-mapping, get-id | -| `outdial-ani` | list, create, get-id, update-id, delete-id | -| `address-book` | list, create, get-id, update-id, delete-id | -| `holiday-list` | list, create, get-id, update-id, delete-id | +| `audio-files` | list, get, create, update, delete | +| `global-variables` | list, create, get, update, delete | +| `business-hour` | list, create, get, update, delete | +| `auxiliary-code` | list, create, get, update, delete | +| `desktop-profile` | list, create, get, update, delete | +| `desktop-layout` | list, create, get, update, delete | +| `skill` | list, create, get, update, delete | +| `skill-profile` | list, create, get, update, delete | +| `multimedia-profile` | list, create, get, update, delete | +| `dial-plan` | list, create, get, update, delete | +| `dial-number` | list, list-dialed-mapping, get | +| `outdial-ani` | list, create, get, update, delete | +| `address-book` | list, create, get, update, delete | +| `holiday-list` | list, create, get, update, delete | ## RSQL Filtering (All Config Resources) @@ -72,15 +72,15 @@ webex cc contact-service-queue list [same flags + --desktop-profile-filter true] webex cc team list [same flags] # Get by ID -webex cc site get-id --id -webex cc entry-point get-id --id -webex cc contact-service-queue get-id --id -webex cc team get-id --id +webex cc site get --id +webex cc entry-point get --id +webex cc contact-service-queue get --id +webex cc team get --id # Create / update / delete webex cc site create --body '{...}' -webex cc site update-id --id --body '{...}' -webex cc site delete-id --id +webex cc site update --id --body '{...}' +webex cc site delete --id # List references (what uses this resource) webex cc site list-references --id @@ -104,13 +104,13 @@ webex cc users list [flags] --supervisor-managed-agents-only true # Get user with profile -webex cc users get-id --id +webex cc users get --id webex cc users get-along-profile-id --id webex cc users get-ci-id --ci-id # Update user (agent settings, team, profile) -webex cc users patch-id --id --body '{...}' -webex cc users update-id --id --body '{...}' +webex cc users patch --id --body '{...}' +webex cc users update --id --body '{...}' # Bulk webex cc users bulk-export @@ -192,15 +192,15 @@ For task controls, `unhold` (alias `resume`) resumes a held voice call; `pause-d webex cc audio-files list [--filter ] [--search ] # Get with download URL -webex cc audio-files get-id --id --include-url true +webex cc audio-files get --id --include-url true # Create / upload webex cc audio-files create --body '{"name":"Main Greeting","description":"..."}' # After creating, upload the WAV via update -webex cc audio-files update-id --id --body '{...}' +webex cc audio-files update --id --body '{...}' # Delete -webex cc audio-files delete-id --id +webex cc audio-files delete --id ``` ## Configuration Resources @@ -209,10 +209,10 @@ All of these (global-variables, business-hour, auxiliary-code, desktop-profile, ```bash webex cc list [--filter ] [--search ] [--page ] [--page-size ] -webex cc get-id --id +webex cc get --id webex cc create --body '{...}' -webex cc update-id --id --body '{...}' -webex cc delete-id --id +webex cc update --id --body '{...}' +webex cc delete --id webex cc list-references --id webex cc bulk-export webex cc bulk-save --body '[{...}]' @@ -225,14 +225,14 @@ webex cc purge-inactive # removes soft-deleted records (most reso # List DN→EP mappings webex cc dial-number list-dialed-mapping [--filter ] webex cc dial-number list [--filter ] -webex cc dial-number get-id --id +webex cc dial-number get --id ``` ### Outdial ANI (has entries sub-resource) ```bash webex cc outdial-ani list -webex cc outdial-ani get-id --id +webex cc outdial-ani get --id webex cc outdial-ani list-entry --id # list ANI entries under an outdial ANI webex cc outdial-ani create-entry --body '{...}' webex cc outdial-ani delete-entry-id --id @@ -242,7 +242,7 @@ webex cc outdial-ani delete-entry-id --id ```bash webex cc address-book list -webex cc address-book get-id --id +webex cc address-book get --id webex cc address-book list-entry --id # list contacts webex cc address-book create-entry --body '{...}' webex cc address-book bulk-save-entry --body '[{...}]' @@ -256,13 +256,13 @@ webex cc address-book delete-entry-id --id 2. **RSQL values with spaces** — wrap values in double quotes inside the RSQL expression: `--filter='name=="Site A"'`. -3. **`get-id` not `get`** — most CC resources use `get-id --id ` (not `get ---id`). The `agents` resource is an exception: it has no `list` or `get-id` commands, only session control operations. +3. **`get` not `get`** — most CC resources use `get --id ` (not `get ---id`). The `agents` resource is an exception: it has no `list` or `get` commands, only session control operations. 4. **`flow` has no CRUD** — `flow` only has `list`, `export`, `import`, `publish`. To create or edit flows, use Webex Contact Center Flow Designer in Control Hub. 5. **Agent statistics time window** — `agents get-activities` and `get-statistics` enforce a **24-hour** max window per request. Use multiple calls to cover longer periods. -6. **Purge vs delete** — `delete-id` soft-deletes. `purge-inactive` permanently removes soft-deleted records for resources that support it. +6. **Purge vs delete** — `delete` soft-deletes. `purge-inactive` permanently removes soft-deleted records for resources that support it. ## Command Reference @@ -286,21 +286,21 @@ webex cc address-book delete-entry-id --id | Command | Flags | |---|---| | `get-mapped-question-id` | `--auto-csat-id` *(required)*, `--id` *(required)* | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list` | `--filter`, `--attributes`, `--page`, `--page-size` | | `list-mapped-question` | `--auto-csat-id` *(required)*, `--filter`, `--attributes`, `--page`, `--page-size` | | `create-mapped-question` | `--auto-csat-id` *(required)*, `--question-id`, `--questionnaire-id`, `--organization-id`, `--id`, `--version`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | | `bulk-save-mapped-question` | `--auto-csat-id` *(required)*, `--body`, `--body-file` | -| `update-id` | `--id` *(required)*, `--agent-inclusion-type`, `--enabled`, `--selected-global-variable-id`, `--survey-data-source`, `--organization-id`, `--version`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--agent-inclusion-type`, `--enabled`, `--selected-global-variable-id`, `--survey-data-source`, `--organization-id`, `--version`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | | `delete-mapped-question-id` | `--auto-csat-id` *(required)*, `--id` *(required)* | ### generated-summaries | Command | Flags | |---|---| -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list` | `--filter`, `--attributes`, `--page`, `--page-size` | -| `update-id` | `--id` *(required)*, `--organization-id`, `--version`, `--call-drop-summaries-enabled`, `--virtual-agent-transfer-summaries-enabled`, `--consult-transfer-summaries-enabled`, `--agent-inclusion-type`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--organization-id`, `--version`, `--call-drop-summaries-enabled`, `--virtual-agent-transfer-summaries-enabled`, `--consult-transfer-summaries-enabled`, `--agent-inclusion-type`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | ### business-hour @@ -308,12 +308,12 @@ webex cc address-book delete-entry-id --id |---|---| | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-count`, `--single-object-response` | | `bulk-export` | `--page`, `--page-size` | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `create` | `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | -| `update-id` | `--id` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### holiday-list @@ -321,12 +321,12 @@ webex cc address-book delete-entry-id --id |---|---| | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-count`, `--single-object-response` | | `bulk-export` | `--page`, `--page-size` | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `create` | `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | -| `update-id` | `--id` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### overrides @@ -334,12 +334,12 @@ webex cc address-book delete-entry-id --id |---|---| | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-latest-override`, `--single-object-response` | | `bulk-export` | `--page`, `--page-size` | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `create` | `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | -| `update-id` | `--id` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### address-book @@ -348,28 +348,28 @@ webex cc address-book delete-entry-id --id | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | | `bulk-export` | `--page`, `--page-size` | | `get-entry-id` | `--address-book-id` *(required)*, `--id` *(required)* | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `list-entry` | `--address-book-id` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | | `create` | `--name`, `--parent-type`, `--organization-id`, `--id`, `--version`, `--description`, `--site-id`, `--body`, `--body-file` | | `create-entry` | `--address-book-id` *(required)*, `--name`, `--number`, `--organization-id`, `--id`, `--version`, `--body`, `--body-file` | | `bulk-save-entry` | `--address-book-id` *(required)*, `--body`, `--body-file` | | `update-entry-id` | `--address-book-id` *(required)*, `--id` *(required)*, `--name`, `--number`, `--organization-id`, `--version`, `--body`, `--body-file` | -| `update-id` | `--id` *(required)*, `--name`, `--parent-type`, `--organization-id`, `--version`, `--description`, `--site-id`, `--body`, `--body-file` | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--name`, `--parent-type`, `--organization-id`, `--version`, `--description`, `--site-id`, `--body`, `--body-file` | | `delete-entry-id` | `--address-book-id` *(required)*, `--id` *(required)* | -| `delete-id` | `--id` *(required)* | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### audio-files | Command | Flags | |---|---| -| `get-id` | `--id` *(required)*, `--include-url` | +| `get` (aliases: `get-id`) | `--id` *(required)*, `--include-url` | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | | `create` | `--body`, `--body-file` | -| `update-id` | `--id` *(required)*, `--body`, `--body-file` | -| `patch-id` | `--id` *(required)*, `--description`, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--body`, `--body-file` | +| `patch` (aliases: `patch-id`) | `--id` *(required)*, `--description`, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### auxiliary-code @@ -377,14 +377,14 @@ webex cc address-book delete-entry-id --id |---|---| | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--desktop-profile-filter`, `--supervised-user-id` | | `bulk-export` | `--page`, `--page-size` | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `create` | `--active`, `--default-code`, `--name`, `--work-type-code`, `--work-type-id`, `--organization-id`, `--id`, `--version`, `--description`, `--is-system-code`, `--burnout-inclusion`, `--system-default`, `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | | `purge-inactive` | `--next-start-id` | -| `update-id` | `--id` *(required)*, `--active`, `--default-code`, `--name`, `--work-type-code`, `--work-type-id`, `--organization-id`, `--version`, `--description`, `--is-system-code`, `--burnout-inclusion`, `--system-default`, `--body`, `--body-file` | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--active`, `--default-code`, `--name`, `--work-type-code`, `--work-type-id`, `--organization-id`, `--version`, `--description`, `--is-system-code`, `--burnout-inclusion`, `--system-default`, `--body`, `--body-file` | | `bulk-partial-update` | `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### contact-number @@ -392,12 +392,12 @@ webex cc address-book delete-entry-id --id |---|---| | `list-all` | — | | `bulk-export` | `--page`, `--page-size` | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | | `create` | `--number`, `--organization-id`, `--id`, `--version`, `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | -| `update-id` | `--id` *(required)*, `--number`, `--organization-id`, `--version`, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--number`, `--organization-id`, `--version`, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### contact-service-queue @@ -406,7 +406,7 @@ webex cc address-book delete-entry-id --id | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--desktop-profile-filter`, `--provisioning-view`, `--single-object-response` | | `bulk-export` | `--type`, `--page`, `--page-size` | | `list-by-skill-profile` (aliases: `list-skill-csqs-skill-profile`) | `--id` *(required)* | -| `get-id` | `--id` *(required)*, `--agents-updated-info` | +| `get` (aliases: `get-id`) | `--id` *(required)*, `--agents-updated-info` | | `list-references` (aliases: `list-csq-references-id`) | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `list-agent-based` | `--userid` *(required)*, `--search`, `--page`, `--page-size` | | `list-skill-based` | `--userid` *(required)*, `--search`, `--page`, `--page-size` | @@ -424,23 +424,23 @@ webex cc address-book delete-entry-id --id | `list-mapping-summary-grouped-assistant-skill` | `--page`, `--page-size`, `--assistant-skill-ids`, `--body`, `--body-file` | | `list-by-dynamic-skills` (aliases: `list-csqs-skills-profile`) | `--body`, `--body-file` | | `list-by-user-skill-profile` (aliases: `list-csqs-user-profile`) | `--body`, `--body-file` | -| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--body`, `--body-file` | | `bulk-partial-update` | `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### desktop-layout | Command | Flags | |---|---| | `bulk-export` | `--page`, `--page-size` | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response`, `--provisioning-view` | | `create` | `--default-json-modified`, `--edited-by`, `--global`, `--json-file-content`, `--json-file-name`, `--name`, `--status`, `--validated`, `--organization-id`, `--id`, `--version`, `--description`, `--validated-time`, `--default-json-modified-time`, `--modified-time`, `--team-ids`, `--system-default`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | | `purge-inactive` | `--next-start-id` | -| `update-id` | `--id` *(required)*, `--default-json-modified`, `--edited-by`, `--global`, `--json-file-content`, `--json-file-name`, `--name`, `--status`, `--validated`, `--organization-id`, `--version`, `--description`, `--validated-time`, `--default-json-modified-time`, `--modified-time`, `--team-ids`, `--system-default`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--default-json-modified`, `--edited-by`, `--global`, `--json-file-content`, `--json-file-name`, `--name`, `--status`, `--validated`, `--organization-id`, `--version`, `--description`, `--validated-time`, `--default-json-modified-time`, `--modified-time`, `--team-ids`, `--system-default`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### desktop-profile @@ -448,13 +448,13 @@ webex cc address-book delete-entry-id --id |---|---| | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response`, `--provisioning-view` | | `bulk-export` | `--page`, `--page-size` | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `create` | `--access-buddy-team`, `--access-entry-point`, `--access-idle-code`, `--access-queue`, `--access-wrap-up-code`, `--active`, `--agent-dnvalidation`, `--name`, `--parent-type`, `--viewable-statistics`, `--organization-id`, `--id`, `--version`, `--description`, `--site-id`, `--screen-popup`, `--last-agent-routing`, `--schedule-and-manage-call-back`, `--auto-wrap-up`, `--auto-answer`, `--agent-personal-greeting`, `--auto-wrap-after-seconds`, `--agent-available-after-outdial`, `--allow-auto-wrap-up-extension`, `--wrap-up-codes`, `--idle-codes`, `--queues`, `--entry-points`, `--buddy-teams`, `--consult-to-queue`, `--outdial-enabled`, `--outdial-entry-point-id`, `--outdial-aniid`, `--address-book-id`, `--dial-plan-enabled`, `--dial-plans`, `--agent-dnvalidation-criteria`, `--agent-dnvalidation-criterions`, `--login-voice-options`, `--threshold-rules`, `--timeout-desktop-inactivity-custom-enabled`, `--show-user-details-ms`, `--state-synchronization-ms`, `--show-user-details-webex`, `--state-synchronization-webex`, `--manage-channel-availability`, `--timeout-desktop-inactivity-mins`, `--system-default`, `--created-time`, `--last-updated-time`, `--auto-accept-digital-interactions`, `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | | `purge-inactive` | `--next-start-id` | -| `update-id` | `--id` *(required)*, `--access-buddy-team`, `--access-entry-point`, `--access-idle-code`, `--access-queue`, `--access-wrap-up-code`, `--active`, `--agent-dnvalidation`, `--name`, `--parent-type`, `--viewable-statistics`, `--organization-id`, `--version`, `--description`, `--site-id`, `--screen-popup`, `--last-agent-routing`, `--schedule-and-manage-call-back`, `--auto-wrap-up`, `--auto-answer`, `--agent-personal-greeting`, `--auto-wrap-after-seconds`, `--agent-available-after-outdial`, `--allow-auto-wrap-up-extension`, `--wrap-up-codes`, `--idle-codes`, `--queues`, `--entry-points`, `--buddy-teams`, `--consult-to-queue`, `--outdial-enabled`, `--outdial-entry-point-id`, `--outdial-aniid`, `--address-book-id`, `--dial-plan-enabled`, `--dial-plans`, `--agent-dnvalidation-criteria`, `--agent-dnvalidation-criterions`, `--login-voice-options`, `--threshold-rules`, `--timeout-desktop-inactivity-custom-enabled`, `--show-user-details-ms`, `--state-synchronization-ms`, `--show-user-details-webex`, `--state-synchronization-webex`, `--manage-channel-availability`, `--timeout-desktop-inactivity-mins`, `--system-default`, `--created-time`, `--last-updated-time`, `--auto-accept-digital-interactions`, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--access-buddy-team`, `--access-entry-point`, `--access-idle-code`, `--access-queue`, `--access-wrap-up-code`, `--active`, `--agent-dnvalidation`, `--name`, `--parent-type`, `--viewable-statistics`, `--organization-id`, `--version`, `--description`, `--site-id`, `--screen-popup`, `--last-agent-routing`, `--schedule-and-manage-call-back`, `--auto-wrap-up`, `--auto-answer`, `--agent-personal-greeting`, `--auto-wrap-after-seconds`, `--agent-available-after-outdial`, `--allow-auto-wrap-up-extension`, `--wrap-up-codes`, `--idle-codes`, `--queues`, `--entry-points`, `--buddy-teams`, `--consult-to-queue`, `--outdial-enabled`, `--outdial-entry-point-id`, `--outdial-aniid`, `--address-book-id`, `--dial-plan-enabled`, `--dial-plans`, `--agent-dnvalidation-criteria`, `--agent-dnvalidation-criterions`, `--login-voice-options`, `--threshold-rules`, `--timeout-desktop-inactivity-custom-enabled`, `--show-user-details-ms`, `--state-synchronization-ms`, `--show-user-details-webex`, `--state-synchronization-webex`, `--manage-channel-availability`, `--timeout-desktop-inactivity-mins`, `--system-default`, `--created-time`, `--last-updated-time`, `--auto-accept-digital-interactions`, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### dial-number @@ -477,12 +477,12 @@ webex cc address-book delete-entry-id --id |---|---| | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | | `bulk-export` | `--page`, `--page-size` | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `create` | `--active`, `--name`, `--regular-expression`, `--organization-id`, `--id`, `--version`, `--description`, `--prefix`, `--stripped-chars`, `--system-default`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | -| `update-id` | `--id` *(required)*, `--active`, `--name`, `--regular-expression`, `--organization-id`, `--version`, `--description`, `--prefix`, `--stripped-chars`, `--system-default`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--active`, `--name`, `--regular-expression`, `--organization-id`, `--version`, `--description`, `--prefix`, `--stripped-chars`, `--system-default`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### entry-point @@ -490,13 +490,13 @@ webex cc address-book delete-entry-id --id |---|---| | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--desktop-profile-filter`, `--provisioning-view`, `--include-count`, `--single-object-response` | | `bulk-export` | `--type`, `--page`, `--page-size` | -| `get-id` | `--id` *(required)*, `--include-names` | +| `get` (aliases: `get-id`) | `--id` *(required)*, `--include-names` | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `create` | `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | | `purge-inactive` | `--next-start-id` | -| `update-id` | `--id` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### global-variables @@ -504,14 +504,14 @@ webex cc address-book delete-entry-id --id |---|---| | `bulk-export` | `--page`, `--page-size` | | `get-reportable-count` | — | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | | `create` | `--active`, `--agent-editable`, `--agent-viewable`, `--default-value`, `--name`, `--reportable`, `--variable-type`, `--organization-id`, `--id`, `--version`, `--description`, `--sensitive`, `--desktop-label`, `--system-default`, `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | | `purge-inactive` | `--next-start-id` | -| `update-id` | `--id` *(required)*, `--active`, `--agent-editable`, `--agent-viewable`, `--default-value`, `--name`, `--reportable`, `--variable-type`, `--organization-id`, `--version`, `--description`, `--sensitive`, `--desktop-label`, `--system-default`, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--active`, `--agent-editable`, `--agent-viewable`, `--default-value`, `--name`, `--reportable`, `--variable-type`, `--organization-id`, `--version`, `--description`, `--sensitive`, `--desktop-label`, `--system-default`, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### multimedia-profile @@ -519,13 +519,13 @@ webex cc address-book delete-entry-id --id |---|---| | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | | `bulk-export` | `--page`, `--page-size` | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `create` | `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | | `purge-inactive` | `--next-start-id` | -| `update-id` | `--id` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### outdial-ani @@ -534,7 +534,7 @@ webex cc address-book delete-entry-id --id | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response` | | `bulk-export` | `--page`, `--page-size` | | `list-entries` (aliases: `list-entry`) | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `get-entry-id` | `--out-dial-ani-id` *(required)*, `--id` *(required)* | | `list-entries-for-ani` (aliases: `list-entry-2`) | `--out-dial-ani-id` *(required)*, `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | @@ -542,9 +542,9 @@ webex cc address-book delete-entry-id --id | `bulk-save` | `--body`, `--body-file` | | `create-entry` | `--out-dial-ani-id` *(required)*, `--name`, `--number`, `--organization-id`, `--id`, `--version`, `--default-anientry`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | | `bulk-save-entries` (aliases: `bulk-save-entry`) | `--out-dial-ani-id` *(required)*, `--body`, `--body-file` | -| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--body`, `--body-file` | | `update-entry-id` | `--out-dial-ani-id` *(required)*, `--id` *(required)*, `--name`, `--number`, `--organization-id`, `--version`, `--default-anientry`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | | `delete-entry-id` | `--out-dial-ani-id` *(required)*, `--id` *(required)* | ### site @@ -553,13 +553,13 @@ webex cc address-book delete-entry-id --id |---|---| | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | | `bulk-export` | `--page`, `--page-size` | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `create` | `--active`, `--multimedia-profile-id`, `--name`, `--organization-id`, `--id`, `--version`, `--description`, `--system-default`, `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | | `purge-inactive` | `--next-start-id` | -| `update-id` | `--id` *(required)*, `--active`, `--multimedia-profile-id`, `--name`, `--organization-id`, `--version`, `--description`, `--system-default`, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--active`, `--multimedia-profile-id`, `--name`, `--organization-id`, `--version`, `--description`, `--system-default`, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### skill @@ -567,14 +567,14 @@ webex cc address-book delete-entry-id --id |---|---| | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response`, `--include` | | `bulk-export` | `--page`, `--page-size` | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `create` | `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | | `purge-inactive` | `--next-start-id` | | `populate-json-attributes-field-skill-id-org` | `--id` *(required)* | -| `update-id` | `--id` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### skill-profile @@ -582,12 +582,12 @@ webex cc address-book delete-entry-id --id |---|---| | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--single-object-response` | | `bulk-export` | `--page`, `--page-size` | -| `get-id` | `--id` *(required)*, `--include-skill-details` | +| `get` (aliases: `get-id`) | `--id` *(required)*, `--include-skill-details` | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `create` | `--active-skills`, `--name`, `--organization-id`, `--id`, `--version`, `--description`, `--active-enum-skills`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | -| `update-id` | `--id` *(required)*, `--active-skills`, `--name`, `--organization-id`, `--version`, `--description`, `--active-enum-skills`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--active-skills`, `--name`, `--organization-id`, `--version`, `--description`, `--active-enum-skills`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### team @@ -595,13 +595,13 @@ webex cc address-book delete-entry-id --id |---|---| | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--supervisor-view`, `--provisioning-view`, `--single-object-response` | | `bulk-export` | `--page`, `--page-size` | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `create` | `--active`, `--name`, `--rank-queues-for-team`, `--site-id`, `--team-status`, `--team-type`, `--organization-id`, `--id`, `--version`, `--dialed-number`, `--capacity`, `--desktop-layout-id`, `--skill-profile-id`, `--multi-media-profile-id`, `--user-ids`, `--description`, `--system-default`, `--queue-rankings`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | | `purge-inactive` | `--next-start-id` | -| `update-id` | `--id` *(required)*, `--active`, `--name`, `--rank-queues-for-team`, `--site-id`, `--team-status`, `--team-type`, `--organization-id`, `--version`, `--dialed-number`, `--capacity`, `--desktop-layout-id`, `--skill-profile-id`, `--multi-media-profile-id`, `--user-ids`, `--description`, `--system-default`, `--queue-rankings`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--active`, `--name`, `--rank-queues-for-team`, `--site-id`, `--team-status`, `--team-type`, `--organization-id`, `--version`, `--dialed-number`, `--capacity`, `--desktop-layout-id`, `--skill-profile-id`, `--multi-media-profile-id`, `--user-ids`, `--description`, `--system-default`, `--queue-rankings`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### user-profiles @@ -609,14 +609,14 @@ webex cc address-book delete-entry-id --id |---|---| | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | | `bulk-export` | `--page`, `--page-size` | -| `get-id` | `--id` *(required)*, `--include-names` | +| `get` (aliases: `get-id`) | `--id` *(required)*, `--include-names` | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `get-acl-id` | `--id` *(required)*, `--names` | | `bulk-save` | `--body`, `--body-file` | | `purge-inactive` | `--next-start-id` | | `create` | `--body`, `--body-file` | -| `update-id` | `--id` *(required)*, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### users @@ -627,15 +627,15 @@ webex cc address-book delete-entry-id --id | `get-ci-id` | `--id` *(required)*, `--include-user-profile`, `--include-names`, `--include-skill-details` | | `list-along-profile` | — | | `get-along-profile-id` | `--id` *(required)* | -| `get-id` | `--id` *(required)*, `--include-count`, `--include-user-profile-type`, `--include-skill-profile-audit`, `--include-reskill-audit-info`, `--include-skill-details`, `--check-if-user-has-dynamic-skill`, `--dynamic-skill-id` | +| `get` (aliases: `get-id`) | `--id` *(required)*, `--include-count`, `--include-user-profile-type`, `--include-skill-profile-audit`, `--include-reskill-audit-info`, `--include-skill-details`, `--check-if-user-has-dynamic-skill`, `--dynamic-skill-id` | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `get-dynamic-skill-id` | `--skill-id` *(required)*, `--search`, `--page`, `--page-size` | | `list-call-monitoring-id` | `--id` *(required)*, `--page`, `--page-size` | | `get-agents-matching-skill-requirements` | `--search`, `--page`, `--page-size`, `--body`, `--body-file` | | `list-by-ids` (aliases: `get-ids`) | `--page`, `--page-size`, `--user-ids`, `--search`, `--queue-id`, `--body`, `--body-file` | -| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--body`, `--body-file` | | `bulk-partial-update` | `--body`, `--body-file` | -| `patch-id` | `--id` *(required)*, `--value-type`, `--body`, `--body-file` | +| `patch` (aliases: `patch-id`) | `--id` *(required)*, `--value-type`, `--body`, `--body-file` | | `bulk-partial-update-dynamic-skills` (aliases: `bulk-update-dynamic-skills`) | `--skill-id` *(required)*, `--body`, `--body-file` | | `reskill-agents` | `--id` *(required)*, `--body`, `--body-file` | @@ -644,14 +644,14 @@ webex cc address-book delete-entry-id --id | Command | Flags | |---|---| | `bulk-export` | `--page`, `--page-size` | -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | | `create` | `--active`, `--name`, `--work-type-code`, `--organization-id`, `--id`, `--version`, `--description`, `--system-default`, `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | | `purge-inactive` | `--next-start-id` | -| `update-id` | `--id` *(required)*, `--active`, `--name`, `--work-type-code`, `--organization-id`, `--version`, `--description`, `--system-default`, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--active`, `--name`, `--work-type-code`, `--organization-id`, `--version`, `--description`, `--system-default`, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### data-sources @@ -857,26 +857,26 @@ Group aliases: `flows`. | Command | Flags | |---|---| -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list` | `--filter`, `--attributes`, `--page`, `--page-size` | | `get-question-mapped-autocsat-id` | `--id` *(required)* | | `list-question-mapped-autocsat` | `--filter`, `--attributes`, `--page`, `--page-size` | | `create-question-mapped-autocsat` | `--question-id`, `--questionnaire-id`, `--organization-id`, `--id`, `--version`, `--created-time`, `--last-updated-time`, `--body`, `--body-file` | | `bulk-save-question-mapped-autocsat` | `--body`, `--body-file` | -| `patch-id` | `--id` *(required)*, `--body`, `--body-file` | +| `patch` (aliases: `patch-id`) | `--id` *(required)*, `--body`, `--body-file` | | `delete-question-mapped-autocsat-id` | `--id` *(required)* | ### agent-personal-greeting-files | Command | Flags | |---|---| -| `get-id` (aliases: `get-id-v2-api`) | `--id` *(required)*, `--include-url` | +| `get` (aliases: `get-id`, `get-id-v2-api`) | `--id` *(required)*, `--include-url` | | `list` | `--filter`, `--search`, `--attributes`, `--page`, `--page-size`, `--include-agent-details` | | `create` (aliases: `create-v2-api`) | `--body`, `--body-file` | | `delete-references` (aliases: `delete-references-1`) | `--body`, `--body-file` | -| `update-id` (aliases: `update-id-v2-api`) | `--id` *(required)*, `--body`, `--body-file` | -| `patch-id` (aliases: `patch-id-v2-api`) | `--id` *(required)*, `--attribute-tag`, `--greeting-purpose-id`, `--body`, `--body-file` | -| `delete-id` (aliases: `delete-id-v2-api`) | `--id` *(required)* | +| `update` (aliases: `update-id`, `update-id-v2-api`) | `--id` *(required)*, `--body`, `--body-file` | +| `patch` (aliases: `patch-id`, `patch-id-v2-api`) | `--id` *(required)*, `--attribute-tag`, `--greeting-purpose-id`, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`, `delete-id-v2-api`) | `--id` *(required)* | ### journey-customer-identification @@ -959,14 +959,14 @@ Group aliases: `flows`. | Command | Flags | |---|---| -| `get-id` | `--id` *(required)* | +| `get` (aliases: `get-id`) | `--id` *(required)* | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size` | | `create` | `--body`, `--body-file` | | `update-default` | `--body`, `--body-file` | -| `update-id` | `--id` *(required)*, `--body`, `--body-file` | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--body`, `--body-file` | | `bulk-partial-update` | `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### contact-list-management @@ -1046,27 +1046,27 @@ Group aliases: `flows`. | Command | Flags | |---|---| -| `get-id` | `--id` *(required)*, `--include-channel-name` | +| `get` (aliases: `get-id`) | `--id` *(required)*, `--include-channel-name` | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-count`, `--single-object-response`, `--include-channel-name`, `--exclude-epassociated` | | `create` | `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | -| `update-id` | `--id` *(required)*, `--body`, `--body-file` | -| `patch-id` | `--id` *(required)*, `--value-type`, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)*, `--body`, `--body-file` | +| `patch` (aliases: `patch-id`) | `--id` *(required)*, `--value-type`, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### channel | Command | Flags | |---|---| -| `get-id` | `--id` *(required)*, `--include-logo-url-versioned` | +| `get` (aliases: `get-id`) | `--id` *(required)*, `--include-logo-url-versioned` | | `list-references` | `--id` *(required)*, `--type`, `--page`, `--page-size` | | `list` | `--filter`, `--attributes`, `--search`, `--page`, `--page-size`, `--sort`, `--include-count`, `--single-object-response`, `--include-logo-url-versioned` | | `create` | `--body`, `--body-file` | | `bulk-save` | `--body`, `--body-file` | -| `update-id` | `--id` *(required)* | -| `patch-id` | `--id` *(required)*, `--description`, `--logo-type`, `--logo-icon-name`, `--body`, `--body-file` | -| `delete-id` | `--id` *(required)* | +| `update` (aliases: `update-id`) | `--id` *(required)* | +| `patch` (aliases: `patch-id`) | `--id` *(required)*, `--description`, `--logo-type`, `--logo-icon-name`, `--body`, `--body-file` | +| `delete` (aliases: `delete-id`) | `--id` *(required)* | ### usage-reports From 8f354da3d8b94b008b6a09a0d6e525ceba5aa0ad Mon Sep 17 00:00:00 2001 From: Ed Umansky Date: Fri, 9 Oct 2026 13:35:16 -0600 Subject: [PATCH 4/6] Include modified and removed commands in refresh inventories --- codegen/INVENTORY.md | 121 ++++++++++++++++++++++++++++++++++---- codegen/diff_spec.py | 95 +++++++++++++++++------------- codegen/test_diff_spec.py | 33 +++++++++++ 3 files changed, 197 insertions(+), 52 deletions(-) create mode 100644 codegen/test_diff_spec.py diff --git a/codegen/INVENTORY.md b/codegen/INVENTORY.md index 53bdb11..8e001c2 100644 --- a/codegen/INVENTORY.md +++ b/codegen/INVENTORY.md @@ -2,6 +2,10 @@ Compared with PR base `85b6a523894c82bb6b8440a103b6f05d39762312`. Added names include renamed/moved operations, not only new Cisco APIs. See [NAMING.md](NAMING.md) for migration details and live route checks. +## Change classification + +**178 added**, **82 modified**, **97 renamed**, **0 deleted**. Added counts include renamed commands. Renamed entries retain aliases; deleted entries would mean the CLI spelling is no longer available. This refresh has no deleted spellings after compatibility aliases are accounted for. Modified entries include method, route, parameters, body, headers, and documentation changes. + ## Coverage | Area | Groups | Spec operations | @@ -27,6 +31,24 @@ Counts cover the normalized spec; handwritten commands and codegen exclusions ca | `webex admin recordings query` | `POST /recordings/query` | Queries recordings with filters in the request body | | `webex admin recordings query-admin-compliance-officer` | `POST /admin/recordings/query` | Queries recordings for an admin or compliance officer with filters in the request body | +### Modified commands + +- **Modified** `webex admin data-sources delete` — path parameters: updated `dataSourceId`; help/description updated +- **Modified** `webex admin data-sources get` — path parameters: updated `dataSourceId`; help/description updated +- **Modified** `webex admin data-sources get-all` — help/description updated +- **Modified** `webex admin data-sources get-schema` — help/description updated +- **Modified** `webex admin data-sources get-schemas` — help/description updated +- **Modified** `webex admin data-sources register` — help/description updated +- **Modified** `webex admin data-sources update` — help/description updated +- **Modified** `webex admin people update-person` — help/description updated +- **Modified** `webex admin recordings list` — help/description updated +- **Modified** `webex admin recordings list-admin-compliance-officer` — help/description updated +- **Modified** `webex admin recordings list-group` — query parameters: removed `topic` +- **Modified** `webex admin reports create` — body fields: added `timeZone` +- **Modified** `webex admin scim-2-users update-patch` — help/description updated +- **Modified** `webex admin scim-2-users update-put` — help/description updated + + ## calling ### Added canonical names @@ -203,17 +225,7 @@ Counts cover the normalized spec; handwritten commands and codegen exclusions ca | `webex cc work-types get` | `GET /organization/{orgid}/work-type/{id}` | Retrieve an existing Work Type by ID in a given organization. | | `webex cc work-types update` | `PUT /organization/{orgid}/work-type/{id}` | Update an existing Work Type by ID in a given organization. | -### Existing names with changed routes - -| Full command | Previous route | Current route | -| --- | --- | --- | -| `webex cc contact-list-management get-within-campaign` | `GET /v3/campaign-management/campaigns/{campaignId}/contact-lists` | `GET /v4/campaign-management/campaigns/{campaignId}/contact-lists` | -| `webex cc flow export` | `GET /flow-store/{orgId}/project/{projectId}/flows/{flowId}:export` | `GET /{orgId}/project/{projectId}/v2/flows/{flowId}:export` | -| `webex cc flow import` | `POST /flow-store/{orgId}/project/{projectId}/flows:import` | `POST /{orgId}/project/{projectId}/v2/flows:import` | -| `webex cc flow list` | `GET /flow-store/{orgId}/project/{projectId}/flows` | `GET /{orgId}/project/{projectId}/flows` | -| `webex cc flow publish` | `POST /flow-store/{orgId}/project/{projectId}/flows/{flowId}:publish` | `POST /{orgId}/project/{projectId}/flows/{flowId}:publish` | - -### Previous canonical names +### Renamed or deleted canonical names | Previous command | Status | | --- | --- | @@ -313,6 +325,67 @@ Counts cover the normalized spec; handwritten commands and codegen exclusions ca | `webex cc work-types get-id` | Alias for `webex cc work-types get` | | `webex cc work-types update-id` | Alias for `webex cc work-types update` | +### Modified commands + +- **Modified** `webex cc agent-personal-greeting-files list` — query parameters: updated `filter`, `includeAgentDetails`; help/description updated +- **Modified** `webex cc agent-summaries list-2` — body fields: removed `agentCiUserId` +- **Modified** `webex cc business-hour bulk-save` — help/description updated +- **Modified** `webex cc business-hour list` — query parameters: updated `includeCount`, `singleObjectResponse`; help/description updated +- **Modified** `webex cc campaign-manager update-request` — JSON body handling changed +- **Modified** `webex cc captures list` — help/description updated +- **Modified** `webex cc contact-list-management get-within-campaign` — path: `/v3/campaign-management/campaigns/{campaignId}/contact-lists` → `/v4/campaign-management/campaigns/{campaignId}/contact-lists`; query parameters: updated `source`; help/description updated +- **Modified** `webex cc contact-list-management update-status-within` — path parameters: updated `contactId` +- **Modified** `webex cc contact-service-queue bulk-partial-update` — help/description updated +- **Modified** `webex cc contact-service-queue bulk-save` — help/description updated +- **Modified** `webex cc contact-service-queue create-remove-agents-users-agent` — help/description updated +- **Modified** `webex cc contact-service-queue list` — query parameters: updated `provisioningView`, `singleObjectResponse`; help/description updated +- **Modified** `webex cc contact-service-queue list-agent-based` — help/description updated +- **Modified** `webex cc contact-service-queue list-skill-based` — help/description updated +- **Modified** `webex cc contact-service-queue list-team-based` — help/description updated +- **Modified** `webex cc contact-service-queue purge-inactive` — query parameters: updated `nextStartId`; help/description updated +- **Modified** `webex cc data-sources delete` — path parameters: updated `dataSourceId`; help/description updated +- **Modified** `webex cc data-sources get` — path parameters: updated `dataSourceId`; help/description updated +- **Modified** `webex cc data-sources get-all` — help/description updated +- **Modified** `webex cc data-sources get-schema` — help/description updated +- **Modified** `webex cc data-sources get-schemas` — help/description updated +- **Modified** `webex cc data-sources register` — help/description updated +- **Modified** `webex cc data-sources update` — help/description updated +- **Modified** `webex cc desktop-layout list` — help/description updated +- **Modified** `webex cc desktop-profile bulk-save` — help/description updated +- **Modified** `webex cc desktop-profile create` — query parameters: added `accessBuddyTeam`, `accessEntryPoint`, `accessIdleCode`, `accessQueue`, `accessWrapUpCode`, `active`, `addressBookId`, `agentAvailableAfterOutdial`, `agentDNValidation`, `agentDNValidationCriteria`, `agentDNValidationCriterions`, `agentPersonalGreeting`, `allowAutoWrapUpExtension`, `autoAcceptDigitalInteractions`, `autoAnswer`, `autoWrapAfterSeconds`, `autoWrapUp`, `buddyTeams`, `consultToQueue`, `createdTime`, `description`, `dialPlanEnabled`, `dialPlans`, `entryPoints`, `id`, `idleCodes`, `lastAgentRouting`, `lastUpdatedTime`, `loginVoiceOptions`, `manageChannelAvailability`, `name`, `organizationId`, `outdialANIId`, `outdialEnabled`, `outdialEntryPointId`, `parentType`, `queues`, `scheduleAndManageCallBack`, `screenPopup`, `showUserDetailsMS`, `showUserDetailsWebex`, `siteId`, `stateSynchronizationMS`, `stateSynchronizationWebex`, `systemDefault`, `thresholdRules`, `timeoutDesktopInactivityCustomEnabled`, `timeoutDesktopInactivityMins`, `version`, `viewableStatistics`, `wrapUpCodes` +- **Modified** `webex cc desktop-profile list` — query parameters: added `provisioningView`; updated `attributes`, `filter`, `singleObjectResponse`; help/description updated +- **Modified** `webex cc desktop-profile purge-inactive` — query parameters: updated `nextStartId`; help/description updated +- **Modified** `webex cc dial-plan bulk-save` — help/description updated +- **Modified** `webex cc dial-plan create` — body fields: added `createdTime`, `lastUpdatedTime`; help/description updated +- **Modified** `webex cc dial-plan list` — query parameters: updated `attributes`, `filter`; help/description updated +- **Modified** `webex cc dial-plan list-references` — help/description updated +- **Modified** `webex cc flow export` — path: `/flow-store/{orgId}/project/{projectId}/flows/{flowId}:export` → `/{orgId}/project/{projectId}/v2/flows/{flowId}:export`; query parameters: added `flowType`; updated `version`; documented response code changed; help/description updated +- **Modified** `webex cc flow import` — path: `/flow-store/{orgId}/project/{projectId}/flows:import` → `/{orgId}/project/{projectId}/v2/flows:import`; query parameters: updated `overwrite`; body fields: added `contactType`, `description`, `flowName`, `flowType`, `status`, `version`; headers: removed `Content-Length`; request body support changed; JSON body handling changed; documented response code changed; help/description updated +- **Modified** `webex cc flow list` — path: `/flow-store/{orgId}/project/{projectId}/flows` → `/{orgId}/project/{projectId}/flows`; query parameters: added `isValidation`, `searchBy`; updated `includePagination`; documented response code changed; help/description updated +- **Modified** `webex cc flow publish` — path: `/flow-store/{orgId}/project/{projectId}/flows/{flowId}:publish` → `/{orgId}/project/{projectId}/flows/{flowId}:publish`; query parameters: added `flowType`, `skipValidation`; documented response code changed; help/description updated +- **Modified** `webex cc holiday-list bulk-save` — help/description updated +- **Modified** `webex cc holiday-list list` — query parameters: updated `includeCount`, `singleObjectResponse`; help/description updated +- **Modified** `webex cc notification subscribe` — help/description updated +- **Modified** `webex cc outdial-ani bulk-save` — help/description updated +- **Modified** `webex cc outdial-ani list` — query parameters: updated `singleObjectResponse`; help/description updated +- **Modified** `webex cc overrides list` — help/description updated +- **Modified** `webex cc realtime subscribe-notification` — help/description updated +- **Modified** `webex cc skill bulk-save` — help/description updated +- **Modified** `webex cc skill create` — query parameters: removed `active`, `createdTime`, `description`, `dynamicSkill`, `enumSkillValues`, `id`, `lastUpdatedTime`, `name`, `organizationId`, `serviceLevelThreshold`, `skillType`, `version`; body fields: added `systemDefault` +- **Modified** `webex cc skill list` — query parameters: added `include`; updated `singleObjectResponse`; help/description updated +- **Modified** `webex cc skill purge-inactive` — query parameters: updated `nextStartId`; help/description updated +- **Modified** `webex cc tasks create` — body fields: added `channelType`; removed `eventTime`, `mediaMgr`, `mediaType`, `orgId`, `trackingId`; help/description updated +- **Modified** `webex cc team bulk-save` — help/description updated +- **Modified** `webex cc team list` — query parameters: updated `filter`, `provisioningView`, `singleObjectResponse`, `supervisorView`; help/description updated +- **Modified** `webex cc team purge-inactive` — query parameters: updated `nextStartId`; help/description updated +- **Modified** `webex cc user-profiles list` — help/description updated +- **Modified** `webex cc users get-agents-matching-skill-requirements` — body fields: removed `condition`, `createdTime`, `dynamicSkill`, `id`, `lastUpdatedTime`, `organizationId`, `skillId`, `skillName`, `skillType`, `skillValue`, `version`, `weight`; JSON body handling changed +- **Modified** `webex cc users get-along-profile-id` — help/description updated +- **Modified** `webex cc users get-ci-id` — query parameters: added `includeSkillDetails` +- **Modified** `webex cc users list` — query parameters: updated `includeAIMappingCount`, `queueId`, `singleObjectResponse`; help/description updated +- **Modified** `webex cc users list-along-profile` — help/description updated + + ## meetings ### Added canonical names @@ -325,6 +398,17 @@ Counts cover the normalized spec; handwritten commands and codegen exclusions ca | `webex meetings recordings query` | `POST /recordings/query` | Queries recordings with filters in the request body | | `webex meetings recordings query-admin-compliance-officer` | `POST /admin/recordings/query` | Queries recordings for an admin or compliance officer with filters in the request body | +### Modified commands + +- **Modified** `webex meetings meetings delete` — help/description updated +- **Modified** `webex meetings meetings patch` — help/description updated +- **Modified** `webex meetings meetings update` — help/description updated +- **Modified** `webex meetings people update-person` — help/description updated +- **Modified** `webex meetings recordings list` — help/description updated +- **Modified** `webex meetings recordings list-admin-compliance-officer` — help/description updated +- **Modified** `webex meetings recordings list-group` — query parameters: removed `topic` + + ## messaging ### Added canonical names @@ -338,13 +422,26 @@ Counts cover the normalized spec; handwritten commands and codegen exclusions ca | `webex messaging hds list-nodes-cluster` | `GET /hds/clusters/{clusterId}/nodes` | Retrieve a list of all nodes for a specific HDS cluster, including availability, proxy details, deployment type, and release version. | | `webex messaging hds list-tenants-org` | `GET /hds/organizations/{organizationId}/tenants` | Retrieve details of Multi-Tenant HDS organization such as Organization Name and ID, CMK state and state of Tenants Organizations. | -### Previous canonical names +### Renamed or deleted canonical names | Previous command | Status | | --- | --- | | `webex messaging hds get-database-org-2` | Alias for `webex messaging hds get-database-config-org` | | `webex messaging hds get-multi-tenant-org-2` | Alias for `webex messaging hds list-tenants-org` | +### Modified commands + +- **Modified** `webex messaging hds get-org` — help/description updated +- **Modified** `webex messaging people update-person` — help/description updated + + +## device + +### Modified commands + +- **Modified** `webex device device-call get-layout-id` — help/description updated +- **Modified** `webex device device-call update-layout-id` — help/description updated + ## Limitations `cc functions import` lacks multipart upload handling. `cc flow import-legacy` lacks legacy upload body handling. Current-format flow import was live-tested; publish was not. Usage report types and completed-task variable updates were not tenant-tested. diff --git a/codegen/diff_spec.py b/codegen/diff_spec.py index 3e9c87c..29fb68c 100644 --- a/codegen/diff_spec.py +++ b/codegen/diff_spec.py @@ -19,7 +19,7 @@ def load_spec(path): - """Load spec and return {collection: {group: {command: method}}}.""" + """Load spec and return {collection: {group: {command: endpoint}}}.""" with open(path) as f: raw = json.load(f) @@ -30,7 +30,7 @@ def load_spec(path): group = g["group"] result[coll][group] = {} for ep in g["endpoints"]: - result[coll][group][ep["command"]] = ep["method"] + result[coll][group][ep["command"]] = ep return result @@ -41,48 +41,63 @@ def cli_path(coll, group, command=None): return f"webex {sub} {group}" -def diff_specs(old, new): - sections = [] +def endpoint_changes(old, new): + """Summarize executable contract changes, independently of request titles.""" + changes = [] + for field in ('method', 'path'): + if old.get(field) != new.get(field): + changes.append(f"{field}: `{old.get(field)}` → `{new.get(field)}`") + for field, label in [('path_params', 'path parameters'), ('query_params', 'query parameters'), + ('body_fields', 'body fields'), ('extra_headers', 'headers')]: + before = {p['name']: p for p in old.get(field, [])} + after = {p['name']: p for p in new.get(field, [])} + added, removed = sorted(after.keys() - before.keys()), sorted(before.keys() - after.keys()) + modified = sorted(k for k in before.keys() & after.keys() if before[k] != after[k]) + details = [] + if added: + details.append('added ' + ', '.join(f'`{k}`' for k in added)) + if removed: + details.append('removed ' + ', '.join(f'`{k}`' for k in removed)) + if modified: + details.append('updated ' + ', '.join(f'`{k}`' for k in modified)) + if details: + changes.append(label + ': ' + '; '.join(details)) + for field, label in [('has_body', 'request body support'), ('complex_body', 'JSON body handling'), + ('aliases', 'compatibility aliases'), ('scopes', 'documented scopes'), + ('response_code', 'documented response code')]: + if old.get(field, [] if field in ('aliases', 'scopes') else None) != new.get(field, [] if field in ('aliases', 'scopes') else None): + changes.append(label + ' changed') + if old.get('description') != new.get('description'): + changes.append('help/description updated') + return changes - all_colls = sorted(set(list(old.keys()) + list(new.keys()))) - for coll in all_colls: - old_groups = old.get(coll, {}) - new_groups = new.get(coll, {}) - - added_groups = sorted(set(new_groups) - set(old_groups)) - removed_groups = sorted(set(old_groups) - set(new_groups)) - common_groups = sorted(set(old_groups) & set(new_groups)) +def diff_specs(old, new): + sections = [] + for coll in sorted(set(old) | set(new)): + old_groups, new_groups = old.get(coll, {}), new.get(coll, {}) lines = [] - - for g in added_groups: - cmds = new_groups[g] - lines.append(f"- **Added group** `{cli_path(coll, g)}` ({len(cmds)} commands)") - for cmd, method in sorted(cmds.items()): - lines.append(f" - `{cli_path(coll, g, cmd)}` ({method})") - - for g in removed_groups: - cmds = old_groups[g] - lines.append(f"- **Removed group** `{cli_path(coll, g)}` ({len(cmds)} commands)") - - for g in common_groups: - added_cmds = sorted(set(new_groups[g]) - set(old_groups[g])) - removed_cmds = sorted(set(old_groups[g]) - set(new_groups[g])) - if not added_cmds and not removed_cmds: - continue - lines.append(f"- `{cli_path(coll, g)}`") - for cmd in added_cmds: - lines.append(f" - **Added** `{cmd}` ({new_groups[g][cmd]})") - for cmd in removed_cmds: - lines.append(f" - **Removed** `{cmd}` ({old_groups[g][cmd]})") - + for group in sorted(set(old_groups) | set(new_groups)): + before, after = old_groups.get(group, {}), new_groups.get(group, {}) + entries = [] + for name in sorted(after.keys() - before.keys()): + entries.append(f" - **Added** `{name}` ({after[name]['method']})") + for name in sorted(before.keys() & after.keys()): + changes = endpoint_changes(before[name], after[name]) + if changes: + entries.append(f" - **Modified** `{name}` — " + '; '.join(changes)) + for name in sorted(before.keys() - after.keys()): + aliases = [n for n, ep in after.items() if name in ep.get('aliases', [])] + if aliases: + entries.append(f" - **Renamed** `{name}` → " + ', '.join(f'`{n}`' for n in aliases) + ' (old spelling retained as an alias)') + else: + entries.append(f" - **Deleted** `{name}` ({before[name]['method']}; command removed, not necessarily the upstream API)") + if entries: + status = '**Added group** ' if group not in old_groups else '**Deleted group** ' if group not in new_groups else '' + lines.extend([f"- {status}`{cli_path(coll, group)}`", *entries, '']) if lines: - sub = COLLECTION_CLI.get(coll, coll) - sections.append(f"### {coll} (`{sub}`)\n") - sections.extend(lines) - sections.append("") - - return "\n".join(sections) + sections.extend([f"### {coll} (`{COLLECTION_CLI.get(coll, coll)}`)", '', *lines]) + return '\n'.join(sections) def main(): diff --git a/codegen/test_diff_spec.py b/codegen/test_diff_spec.py new file mode 100644 index 0000000..b8253ea --- /dev/null +++ b/codegen/test_diff_spec.py @@ -0,0 +1,33 @@ +import unittest +from diff_spec import diff_specs, endpoint_changes + + +class SpecDiffTest(unittest.TestCase): + def test_route_and_body_changes_are_reported_without_renaming(self): + old = {'method': 'POST', 'path': '/legacy', 'has_body': False} + new = {'method': 'POST', 'path': '/v2', 'has_body': True} + report = diff_specs({'Webex Contact Center': {'flow': {'import': old}}}, + {'Webex Contact Center': {'flow': {'import': new}}}) + self.assertIn('**Modified** `import`', report) + self.assertIn('`/legacy` → `/v2`', report) + self.assertIn('request body support changed', report) + + def test_alias_is_a_rename_not_a_deletion(self): + old = {'Webex Contact Center': {'site': {'get-id': {'method': 'GET'}}}} + new = {'Webex Contact Center': {'site': {'get': {'method': 'GET', 'aliases': ['get-id']}}}} + report = diff_specs(old, new) + self.assertIn('**Renamed** `get-id` → `get`', report) + self.assertNotIn('**Deleted**', report) + + def test_deleted_group_lists_every_removed_command(self): + report = diff_specs({'Webex Contact Center': {'old': {'one': {'method': 'GET'}, 'two': {'method': 'POST'}}}}, {}) + self.assertIn('**Deleted group**', report) + self.assertIn('**Deleted** `one`', report) + self.assertIn('**Deleted** `two`', report) + + def test_parameter_add_remove_and_type_change(self): + old = {'body_fields': [{'name': 'old'}, {'name': 'shared', 'type': 'string'}]} + new = {'body_fields': [{'name': 'new'}, {'name': 'shared', 'type': 'bool'}]} + report = '; '.join(endpoint_changes(old, new)) + for expected in ['added `new`', 'removed `old`', 'updated `shared`']: + self.assertIn(expected, report) From a6d1beb65fb06bb7011fa41cb89c9e8e0f777a61 Mon Sep 17 00:00:00 2001 From: Ed Umansky Date: Fri, 9 Oct 2026 13:52:20 -0600 Subject: [PATCH 5/6] Fix usage report deletion and document Cloverhound live tests --- cmd/cc/usage_reports.go | 1 + codegen/INVENTORY.md | 2 +- codegen/LIVE_TESTS.md | 42 ++++++++++++++++++++++++++++++++++++ codegen/generate_cli.py | 5 +++++ codegen/test_generate_cli.py | 17 +++++++++++++++ site/src/content/docs/cc.mdx | 2 ++ skill/cc/SKILL.md | 2 ++ 7 files changed, 70 insertions(+), 1 deletion(-) create mode 100644 codegen/LIVE_TESTS.md create mode 100644 codegen/test_generate_cli.py diff --git a/cmd/cc/usage_reports.go b/cmd/cc/usage_reports.go index 1c6d075..01c4912 100644 --- a/cmd/cc/usage_reports.go +++ b/cmd/cc/usage_reports.go @@ -156,6 +156,7 @@ func init() { Long: `Deletes the specified usage report and its associated file. This operation cannot be undone.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/v1/usage-reports/{reportId}") + req.Header("Accept", "*/*") req.PathParam("reportId", reportId) resp, statusCode, err := req.Do() if err != nil { diff --git a/codegen/INVENTORY.md b/codegen/INVENTORY.md index 8e001c2..e8e29c7 100644 --- a/codegen/INVENTORY.md +++ b/codegen/INVENTORY.md @@ -444,4 +444,4 @@ Counts cover the normalized spec; handwritten commands and codegen exclusions ca ## Limitations -`cc functions import` lacks multipart upload handling. `cc flow import-legacy` lacks legacy upload body handling. Current-format flow import was live-tested; publish was not. Usage report types and completed-task variable updates were not tenant-tested. +`cc functions import` lacks multipart upload handling. `cc flow import-legacy` lacks legacy upload body handling. Current-format flow import was live-tested; publish was not. Usage report types, report creation/status/download/deletion, call-quality metrics, and additional refreshed reads were tenant-tested on Cloverhound; see [LIVE_TESTS.md](LIVE_TESTS.md). Completed-task variable updates were dry-run checked only. Self-service call controls returned 403, archived-user query returned a gateway 404, and HDS confirmed the organization has no clusters. diff --git a/codegen/LIVE_TESTS.md b/codegen/LIVE_TESTS.md new file mode 100644 index 0000000..93c4720 --- /dev/null +++ b/codegen/LIVE_TESTS.md @@ -0,0 +1,42 @@ +# Cloverhound CLI live validation + +Tested 2026-10-09 with the CLI built from branch `auto/update-postman-collections`, starting at `8f354da`, plus the usage-report deletion fix found during testing. Authentication: `eumansky@cloverhound.com`; organization UUID: `67b6b831-2fb5-448a-b5f5-b06e5e6253c2`; Contact Center region: US. + +These are selected live smoke tests, not coverage of every refreshed endpoint. Calls used explicit user/organization selection and disabled 429 retries. Outputs and errors were captured separately. Existing resources were read only; writes were limited to a disposable unpublished/unassigned flow and a disposable usage report. + +| Commands tested | Result | +|---|---| +| `webex cc flow list`, `get`, `export --version=draft` | 200; ten existing flows; typed FlowV2 get/export payloads match | +| `webex cc flow export-legacy --version=draft` | 200; legacy process/diagram contract differs from typed export | +| `webex cc activities list-definitions`, `describe --activity-name=queue-contact` | 200; 54 definitions; activity schema retrieved | +| `webex cc activities get-input-choices --activity-name=queue-contact --input-name=channelType` | 200; static choices retrieved | +| `webex cc activities get-input-choices --activity-name=queue-contact --input-name=destination --parent-input-name=channelType --parent-value=TELEPHONY` | 200; dependent queue choices retrieved | +| `webex cc events list-specifications` | 200 | +| `webex cc templates list-flow`, `get-flow --id ` | 200; 39 templates; individual template retrieved | +| `webex cc functions list`, `list-options`, `get --id --meta-data-only=true` | 200; existing function metadata and runtime choices retrieved; no execution/publishing | +| `webex cc asset list`, `webex cc channel list` | 200; empty lists (no item-level CRUD tested) | +| `webex cc site list`, `get --id `, `get-id --id ` | 200; four sites; canonical command and compatibility alias returned identical JSON | +| `webex calling locations list` | 200; baseline Calling read | +| `webex calling metrics get-call-quality-stats --last=24h` | 200; three calls, one call with media, one good-quality media call | +| `webex meetings recordings query --from=2026-10-01T00:00:00Z --to=2026-10-09T00:00:00Z --max=5` | 200; empty result; POST read query worked | +| `webex cc usage-reports list-resource-types`, `list` | 200; five record types; initial report list empty | +| `webex cc usage-reports create --resource-type=ContactSessionRecord --start-date=2026-10-08 --end-date=2026-10-08` | 200; report created asynchronously | +| `webex cc usage-reports get --report-id ` | 200; queued → in progress → completed in approximately 55 seconds | +| `webex cc usage-reports download-file --file-id --output=raw` | 200; 1,333-byte gzip; integrity verified; decompressed CSV 4,086 bytes, 218 columns, zero data rows | +| `webex cc usage-reports delete --report-id ` | Initially 406; after generator fix, 204; subsequent get 404 and list empty | +| `webex cc external-data-updates update-task-global-variables --dry-run --body ` | PUT route/body construction checked; no live update or server-side body validation | +| `webex calling call-controls-for-me list` | 403 Forbidden; this login cannot use the endpoint; cause not established by this test | +| `webex admin archive-users query --filter='username eq "eumansky@cloverhound.com"'` | 404, gateway message “API Definition not found”; not a successful archived-user lookup; route/authentication requirements remain unverified | +| `webex messaging hds list-clusters-org --organization-id ` | 404, explicit service message “This organization does not contain any HDS clusters”; tenant prerequisite absent | + +## Disposable flow lifecycle + +Created `CLI_Smoke_Test_be85fe3abc76` (`6ac944e949c39e7ea3c4ce32`) with only start/disconnect nodes. Validation returned `valid: true` with an activity-description recommendation. Import returned 201. Get/list confirmed Draft status and no routing assignments. Lock, patch-draft, save-draft, export, validate-draft, export-legacy, and unlock returned 200. Readback assertions verified both description changes. Import and draft writes returned a `flow` wrapper with preflight warnings; reads/typed export returned the FlowV2 document directly. + +Deletion used `--force=no --skip-rs-epcheck=false`, returned 200, and subsequent get returned 404. Final list contained the same ten original flow IDs. The temporary flow was never published or assigned. Existing flow get/export reads matched; existing flows were not written. + +## Fix and limits + +The usage-report delete endpoint rejected `Accept: application/json` with 406. Code generation now emits `Accept: */*` for that exact DELETE route, allowing its non-JSON acknowledgement. Live retry returned 204 and cleanup was verified. Other routes retain their existing Accept behavior. A generation regression check guards that scope. + +No live task controls, completed-task variable updates, existing configuration changes, flow publishing, legacy flow import, or function import/execution were attempted. Populated usage CSV rows and asset/channel item operations remain untested. Raw response artifacts are local under `/tmp/webex-live-results`; they are not committed because they contain organization data. diff --git a/codegen/generate_cli.py b/codegen/generate_cli.py index a3bf623..cf770b4 100644 --- a/codegen/generate_cli.py +++ b/codegen/generate_cli.py @@ -367,6 +367,11 @@ def generate_command(ep, group_var, base_url_expr, is_calling): lines.append(f'{indent3}req := client.NewRequest({base_url_expr}, "{method}", {escape_go_double_quoted(path)})') + # This endpoint returns a non-JSON deletion acknowledgement. Restricting + # Accept to application/json causes the service to reject it with HTTP 406. + if method == 'DELETE' and path == '/v1/usage-reports/{reportId}': + lines.append(f'{indent3}req.Header("Accept", "*/*")') + # --last → from/to conversion if has_from: parse_func = 'timeutil.ParseLastEpochMs' if path in EPOCH_MS_PATHS else 'timeutil.ParseLastISO' diff --git a/codegen/test_generate_cli.py b/codegen/test_generate_cli.py new file mode 100644 index 0000000..39e8fd4 --- /dev/null +++ b/codegen/test_generate_cli.py @@ -0,0 +1,17 @@ +"""Regression checks for service-specific request generation.""" +import unittest + +from generate_cli import generate_command + + +class UsageReportNegotiationTest(unittest.TestCase): + def test_only_report_delete_accepts_non_json_acknowledgement(self): + for method, path, expected in [ + ('DELETE', '/v1/usage-reports/{reportId}', True), + ('GET', '/v1/usage-reports/{reportId}', False), + ('DELETE', '/v1/tasks/{taskId}', False), + ]: + with self.subTest(method=method, path=path): + endpoint = {'command': 'example', 'method': method, 'path': path} + code = '\n'.join(generate_command(endpoint, 'exampleCmd', 'config.CcBaseURL', False)) + self.assertEqual('req.Header("Accept", "*/*")' in code, expected) diff --git a/site/src/content/docs/cc.mdx b/site/src/content/docs/cc.mdx index ee89549..f53ef5b 100644 --- a/site/src/content/docs/cc.mdx +++ b/site/src/content/docs/cc.mdx @@ -200,4 +200,6 @@ webex cc external-data-updates update-task-global-variables --body-file task-upd Discover report types before creating a report; the collection does not enumerate the types or CSV columns. Download with `fileId`, not `reportId`. Reports can span available data up to 36 months, may split into monthly files, and expire seven days after completion. Only one report processes per organization at a time. +Cloverhound live tests returned `AgentActivityRecord`, `AgentSessionRecord`, `ContactActivityRecord`, `ContactSessionRecord`, and `ContactLegRecord`. A single-day Contact Session Record report completed and downloaded as gzip-compressed CSV; check the downloaded format before parsing it. Use `--output raw` to preserve file bytes. Report deletion and cleanup were verified. Completed-task variable updates have only been dry-run checked. + For task controls, `unhold` (alias `resume`) resumes a held voice call; `pause-digital` and `resume-digital` handle paused non-real-time digital tasks. `append-message` retains `update-2` as an alias. Queue lookups use `list-agent-based`, `list-skill-based`, `list-team-based`, `list-by-skill-profile`, `list-by-dynamic-skills`, and `list-by-user-skill-profile`; pass IDs as flags. Whisper coaching is beta. The refresh also adds conference-participant removal, campaign-time lookup, and contact closure across a campaign chain. diff --git a/skill/cc/SKILL.md b/skill/cc/SKILL.md index 46d374c..142b79a 100644 --- a/skill/cc/SKILL.md +++ b/skill/cc/SKILL.md @@ -183,6 +183,8 @@ webex cc external-data-updates update-task-global-variables --body-file task-upd Discover report types before creating a report; the collection does not enumerate the types or CSV columns. Download with `fileId`, not `reportId`. Reports can span available data up to 36 months, may split into monthly files, and expire seven days after completion. Only one report processes per organization at a time. +Cloverhound live tests returned `AgentActivityRecord`, `AgentSessionRecord`, `ContactActivityRecord`, `ContactSessionRecord`, and `ContactLegRecord`. A single-day Contact Session Record report completed and downloaded as gzip-compressed CSV; check the downloaded format before parsing it. Use `--output raw` to preserve file bytes. Report deletion accepts the service's non-JSON acknowledgement; cleanup returned 204 and subsequent retrieval returned 404. Completed-task variable updates have only been dry-run checked. + For task controls, `unhold` (alias `resume`) resumes a held voice call; `pause-digital` and `resume-digital` handle paused non-real-time digital tasks. `append-message` retains `update-2` as an alias. Queue lookups use `list-agent-based`, `list-skill-based`, `list-team-based`, `list-by-skill-profile`, `list-by-dynamic-skills`, and `list-by-user-skill-profile`; pass IDs as flags. Whisper coaching is beta. The refresh also adds conference-participant removal, campaign-time lookup, and contact closure across a campaign chain. ## Audio Files From d98de1a638315b993cab93a7fa87a9e2ffbfb7b9 Mon Sep 17 00:00:00 2001 From: Ed Umansky Date: Fri, 9 Oct 2026 14:01:00 -0600 Subject: [PATCH 6/6] Remove session logs and organize command documentation --- AGENTS.md | 6 +- CLAUDE_DESKTOP.md | 2 +- README.md | 2 +- codegen/LIVE_TESTS.md | 42 ---- codegen/README.md | 13 ++ .../INVENTORY.md => docs/command-inventory.md | 4 +- .../NAMING.md => docs/command-migration.md | 190 +++++++----------- site/README.md | 2 +- site/src/content/docs/agent-skill.mdx | 2 +- site/src/content/docs/cc.mdx | 8 +- skill/SKILL.md | 4 +- skill/cc/SKILL.md | 8 +- 12 files changed, 107 insertions(+), 176 deletions(-) delete mode 100644 codegen/LIVE_TESTS.md create mode 100644 codegen/README.md rename codegen/INVENTORY.md => docs/command-inventory.md (98%) rename codegen/NAMING.md => docs/command-migration.md (54%) diff --git a/AGENTS.md b/AGENTS.md index 711cfe5..50e4f20 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -32,8 +32,8 @@ make download `make codegen` runs `extract_api_spec.py`, `generate_cli.py`, and `generate_skills.py`. For command naming exceptions, edit `codegen/naming_overrides.py`; see -`codegen/NAMING.md` for naming and compatibility conventions, and -`codegen/INVENTORY.md` for the reviewed refresh inventory. These route-based +`docs/command-migration.md` for naming and compatibility conventions, and +`docs/command-inventory.md` for the reviewed refresh inventory. These route-based overrides feed both generated commands and skill references. Use `custom_*.go` and the generator skip lists when the request itself needs handwritten handling. @@ -85,4 +85,4 @@ gh release edit v0.X.0 --title "v0.X.0" --notes "## Improvements ## Documentation checks -Update README, the site area pages, and handwritten skill guidance alongside API changes. Run `make codegen` for all six generated skill references, `python3 -m unittest discover -s codegen -p 'test_*.py'` for naming checks, and `npm run build` in `site/` for documentation validation. Preserve the live-test evidence and known import limitations in the naming reference. +Update README, the site area pages, and handwritten skill guidance alongside API changes. Run `make codegen` for all six generated skill references, `python3 -m unittest discover -s codegen -p 'test_*.py'` for naming checks, and `npm run build` in `site/` for documentation validation. Keep command documentation focused on behavior, compatibility, and known limitations. Put PR validation and work-session results in the PR, not repository documentation; do not include personal identities or tenant test data. diff --git a/CLAUDE_DESKTOP.md b/CLAUDE_DESKTOP.md index ae59d02..7a5af10 100644 --- a/CLAUDE_DESKTOP.md +++ b/CLAUDE_DESKTOP.md @@ -147,6 +147,6 @@ Use `webex auth set-org ` to set a persistent org override, or pass `--or ## Updated command references -Use the repository skill files from the same revision as your CLI. The Postman refresh adds Calling metrics/personal controls, Contact Center flow authoring and functions, usage reports, and HDS monitoring. See the [refresh inventory](codegen/INVENTORY.md) and [command migration map](codegen/NAMING.md). +Use the repository skill files from the same revision as your CLI. The Postman refresh adds Calling metrics/personal controls, Contact Center flow authoring and functions, usage reports, and HDS monitoring. See the [refresh inventory](docs/command-inventory.md) and [command migration map](docs/command-migration.md). `cc flow import`/`export` now use current-format flow JSON; `export-legacy` retains raw FDL. Legacy flow import and custom-function import still lack their upload implementations. `cc tasks resume` remains a voice-unhold alias; digital tasks use `resume-digital`. Refresh previously installed skill copies after upgrading the CLI. diff --git a/README.md b/README.md index a8f9504..cc3d144 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ Resource operations use `get`, `delete`, `patch`, and `update` with `--id`; prev - `cc tasks resume` still means voice unhold. Digital tasks use `pause-digital`/`resume-digital`. - Messaging consolidates HDS operations under `hds`, with `hybrid-data-security` as an alias. Admin and Meetings add body-based recording searches; Meetings also adds group service-app operations. -See the [full refresh inventory](codegen/INVENTORY.md), [every renamed command](codegen/NAMING.md), and [Contact Center skill](skill/cc/SKILL.md) for migration details and examples. Upstream collections remain unchanged; overrides control names, routes, and product placement. +See the [full refresh inventory](docs/command-inventory.md), [every renamed command](docs/command-migration.md), and [Contact Center skill](skill/cc/SKILL.md) for migration details and examples. Upstream collections remain unchanged; overrides control names, routes, and product placement. ## Authentication diff --git a/codegen/LIVE_TESTS.md b/codegen/LIVE_TESTS.md deleted file mode 100644 index 93c4720..0000000 --- a/codegen/LIVE_TESTS.md +++ /dev/null @@ -1,42 +0,0 @@ -# Cloverhound CLI live validation - -Tested 2026-10-09 with the CLI built from branch `auto/update-postman-collections`, starting at `8f354da`, plus the usage-report deletion fix found during testing. Authentication: `eumansky@cloverhound.com`; organization UUID: `67b6b831-2fb5-448a-b5f5-b06e5e6253c2`; Contact Center region: US. - -These are selected live smoke tests, not coverage of every refreshed endpoint. Calls used explicit user/organization selection and disabled 429 retries. Outputs and errors were captured separately. Existing resources were read only; writes were limited to a disposable unpublished/unassigned flow and a disposable usage report. - -| Commands tested | Result | -|---|---| -| `webex cc flow list`, `get`, `export --version=draft` | 200; ten existing flows; typed FlowV2 get/export payloads match | -| `webex cc flow export-legacy --version=draft` | 200; legacy process/diagram contract differs from typed export | -| `webex cc activities list-definitions`, `describe --activity-name=queue-contact` | 200; 54 definitions; activity schema retrieved | -| `webex cc activities get-input-choices --activity-name=queue-contact --input-name=channelType` | 200; static choices retrieved | -| `webex cc activities get-input-choices --activity-name=queue-contact --input-name=destination --parent-input-name=channelType --parent-value=TELEPHONY` | 200; dependent queue choices retrieved | -| `webex cc events list-specifications` | 200 | -| `webex cc templates list-flow`, `get-flow --id ` | 200; 39 templates; individual template retrieved | -| `webex cc functions list`, `list-options`, `get --id --meta-data-only=true` | 200; existing function metadata and runtime choices retrieved; no execution/publishing | -| `webex cc asset list`, `webex cc channel list` | 200; empty lists (no item-level CRUD tested) | -| `webex cc site list`, `get --id `, `get-id --id ` | 200; four sites; canonical command and compatibility alias returned identical JSON | -| `webex calling locations list` | 200; baseline Calling read | -| `webex calling metrics get-call-quality-stats --last=24h` | 200; three calls, one call with media, one good-quality media call | -| `webex meetings recordings query --from=2026-10-01T00:00:00Z --to=2026-10-09T00:00:00Z --max=5` | 200; empty result; POST read query worked | -| `webex cc usage-reports list-resource-types`, `list` | 200; five record types; initial report list empty | -| `webex cc usage-reports create --resource-type=ContactSessionRecord --start-date=2026-10-08 --end-date=2026-10-08` | 200; report created asynchronously | -| `webex cc usage-reports get --report-id ` | 200; queued → in progress → completed in approximately 55 seconds | -| `webex cc usage-reports download-file --file-id --output=raw` | 200; 1,333-byte gzip; integrity verified; decompressed CSV 4,086 bytes, 218 columns, zero data rows | -| `webex cc usage-reports delete --report-id ` | Initially 406; after generator fix, 204; subsequent get 404 and list empty | -| `webex cc external-data-updates update-task-global-variables --dry-run --body ` | PUT route/body construction checked; no live update or server-side body validation | -| `webex calling call-controls-for-me list` | 403 Forbidden; this login cannot use the endpoint; cause not established by this test | -| `webex admin archive-users query --filter='username eq "eumansky@cloverhound.com"'` | 404, gateway message “API Definition not found”; not a successful archived-user lookup; route/authentication requirements remain unverified | -| `webex messaging hds list-clusters-org --organization-id ` | 404, explicit service message “This organization does not contain any HDS clusters”; tenant prerequisite absent | - -## Disposable flow lifecycle - -Created `CLI_Smoke_Test_be85fe3abc76` (`6ac944e949c39e7ea3c4ce32`) with only start/disconnect nodes. Validation returned `valid: true` with an activity-description recommendation. Import returned 201. Get/list confirmed Draft status and no routing assignments. Lock, patch-draft, save-draft, export, validate-draft, export-legacy, and unlock returned 200. Readback assertions verified both description changes. Import and draft writes returned a `flow` wrapper with preflight warnings; reads/typed export returned the FlowV2 document directly. - -Deletion used `--force=no --skip-rs-epcheck=false`, returned 200, and subsequent get returned 404. Final list contained the same ten original flow IDs. The temporary flow was never published or assigned. Existing flow get/export reads matched; existing flows were not written. - -## Fix and limits - -The usage-report delete endpoint rejected `Accept: application/json` with 406. Code generation now emits `Accept: */*` for that exact DELETE route, allowing its non-JSON acknowledgement. Live retry returned 204 and cleanup was verified. Other routes retain their existing Accept behavior. A generation regression check guards that scope. - -No live task controls, completed-task variable updates, existing configuration changes, flow publishing, legacy flow import, or function import/execution were attempted. Populated usage CSV rows and asset/channel item operations remain untested. Raw response artifacts are local under `/tmp/webex-live-results`; they are not committed because they contain organization data. diff --git a/codegen/README.md b/codegen/README.md new file mode 100644 index 0000000..5264ae0 --- /dev/null +++ b/codegen/README.md @@ -0,0 +1,13 @@ +# Code generation + +Run `make codegen` from the repository root to extract API specifications, generate Go commands, and refresh skill command references. Run `make refresh` to download collections first. + +Generated files in the six command area packages must not be edited by hand. Change `generate_cli.py` for generation behavior or use `custom_*.go` with the generator skip lists for handwritten request implementations. + +## Naming overrides + +Define route-specific group names, command names, and compatibility aliases in `naming_overrides.py`. Overrides are keyed by collection, source group, HTTP method, and route so collection reordering does not affect names. Use meaningful resource/action names rather than numeric collision suffixes. IDs belong in flags; exact `get-id`, `delete-id`, `patch-id`, and `update-id` names are shortened centrally with compatibility aliases and collision checks. + +Preserve aliases when a name changes without changing the operation. Do not reuse an alias for a different operation or request format. Keep legacy FDL import/export distinct from current typed flow documents. Duplicate route exclusions must identify a replacement; extraction fails if that replacement disappears. + +After changes, run `make codegen`, `make check`, and `python3 -m unittest discover -s codegen -p 'test_*.py'`. Update the [command migration reference](../docs/command-migration.md), [command inventory](../docs/command-inventory.md), and affected documentation/skills when public commands change. diff --git a/codegen/INVENTORY.md b/docs/command-inventory.md similarity index 98% rename from codegen/INVENTORY.md rename to docs/command-inventory.md index e8e29c7..091e758 100644 --- a/codegen/INVENTORY.md +++ b/docs/command-inventory.md @@ -1,6 +1,6 @@ # Postman refresh inventory -Compared with PR base `85b6a523894c82bb6b8440a103b6f05d39762312`. Added names include renamed/moved operations, not only new Cisco APIs. See [NAMING.md](NAMING.md) for migration details and live route checks. +Changes introduced by the Postman collection refresh. Added names include renamed/moved operations, not only new Cisco APIs. See [command-migration.md](command-migration.md) for migration details. ## Change classification @@ -444,4 +444,4 @@ Counts cover the normalized spec; handwritten commands and codegen exclusions ca ## Limitations -`cc functions import` lacks multipart upload handling. `cc flow import-legacy` lacks legacy upload body handling. Current-format flow import was live-tested; publish was not. Usage report types, report creation/status/download/deletion, call-quality metrics, and additional refreshed reads were tenant-tested on Cloverhound; see [LIVE_TESTS.md](LIVE_TESTS.md). Completed-task variable updates were dry-run checked only. Self-service call controls returned 403, archived-user query returned a gateway 404, and HDS confirmed the organization has no clusters. +`cc functions import` lacks multipart upload handling. `cc flow import-legacy` lacks legacy upload body handling. Use current-format `flow import --body-file` for typed flow documents; legacy imports require an upload implementation. diff --git a/codegen/NAMING.md b/docs/command-migration.md similarity index 54% rename from codegen/NAMING.md rename to docs/command-migration.md index 29d1fcf..a8cbe4a 100644 --- a/codegen/NAMING.md +++ b/docs/command-migration.md @@ -2,7 +2,7 @@ Every row gives the full previous command, its current canonical command, what the operation does, and whether the previous spelling still invokes that same operation. Append `--help` to any current command to see its arguments and flags. -**Previous-name source:** “PR #10” means the automatic refresh before our naming overrides. “Before refresh” means an older spelling retained for compatibility. These are different baselines: in particular, `webex cc tasks resume` meant unhold before the refresh, but the unmodified PR assigned it to digital-task resume. +**Previous-name source:** “Generated collection” identifies names produced without naming overrides. “Before refresh” identifies older CLI names retained for compatibility. In particular, `webex cc tasks resume` historically meant unhold; the unnormalized collection assigned that name to digital-task resume. **Flow formats:** `flow import`/`export` use the current typed flow document; `import-legacy`/`export-legacy` use deprecated raw FDL. This intentionally changes the format of the pre-refresh unsuffixed commands. Current flow, activity, event, and template commands use unprefixed URLs. Duplicate prefixed commands and the temporary `-direct` names have been removed. @@ -12,25 +12,25 @@ The refresh tables below contain **94 previous-to-current mappings**, followed b | Previous full command | Source | Current full command | What it does | Previous spelling still works? | | --- | --- | --- | --- | --- | -| `webex calling call-controls dial-2` | PR #10 | `webex calling call-controls-for-me dial` | Initiate an outbound call to a specified destination. | No — use the new command | -| `webex calling call-controls answer-2` | PR #10 | `webex calling call-controls-for-me answer` | Answer an incoming call. | No — use the new command | -| `webex calling call-controls hangup-2` | PR #10 | `webex calling call-controls-for-me hangup` | Hangup a call. | No — use the new command | -| `webex calling call-controls list-2` | PR #10 | `webex calling call-controls-for-me list` | Get the list of details for all active calls associated with the user. | No — use the new command | -| `webex calling call-controls get-3` | PR #10 | `webex calling call-controls-for-me get` | Get the details of the specified active call for the user. | No — use the new command | +| `webex calling call-controls dial-2` | Generated collection | `webex calling call-controls-for-me dial` | Initiate an outbound call to a specified destination. | No — use the new command | +| `webex calling call-controls answer-2` | Generated collection | `webex calling call-controls-for-me answer` | Answer an incoming call. | No — use the new command | +| `webex calling call-controls hangup-2` | Generated collection | `webex calling call-controls-for-me hangup` | Hangup a call. | No — use the new command | +| `webex calling call-controls list-2` | Generated collection | `webex calling call-controls-for-me list` | Get the list of details for all active calls associated with the user. | No — use the new command | +| `webex calling call-controls get-3` | Generated collection | `webex calling call-controls-for-me get` | Get the details of the specified active call for the user. | No — use the new command | ## calling metrics | Previous full command | Source | Current full command | What it does | Previous spelling still works? | | --- | --- | --- | --- | --- | -| `webex admin calling-metrics webex-call-quality-stats` | PR #10 | `webex calling metrics get-call-quality-stats` | Retrieve aggregated Calling call and media-quality statistics for the authenticated organization. Requires Pro Pack; query up to seven days within the previous three weeks. | No — use the new command | +| `webex admin calling-metrics webex-call-quality-stats` | Generated collection | `webex calling metrics get-call-quality-stats` | Retrieve aggregated Calling call and media-quality statistics for the authenticated organization. Requires Pro Pack; query up to seven days within the previous three weeks. | No — use the new command | ## cc activities | Previous full command | Source | Current full command | What it does | Previous spelling still works? | | --- | --- | --- | --- | --- | -| `webex cc activities list-definitions-2` | PR #10 | `webex cc activities list-definitions` | List all available activity types with their full schemas, including inputs, outputs, ports, and descriptions. | No — use the new command | -| `webex cc activities describe-2` | PR #10 | `webex cc activities describe` | Retrieve a single activity's full definition, including inputs, outputs, named ports, and the JSON Schema for its inputs — all returned inline. | No — use the new command | -| `webex cc activities get-input-choices-2` | PR #10 | `webex cc activities get-input-choices` | Resolve valid values for an activity input, such as queues, audio files, or agents; supports search, validation, and cascading parent inputs. | No — use the new command | +| `webex cc activities list-definitions-2` | Generated collection | `webex cc activities list-definitions` | List all available activity types with their full schemas, including inputs, outputs, ports, and descriptions. | No — use the new command | +| `webex cc activities describe-2` | Generated collection | `webex cc activities describe` | Retrieve a single activity's full definition, including inputs, outputs, named ports, and the JSON Schema for its inputs — all returned inline. | No — use the new command | +| `webex cc activities get-input-choices-2` | Generated collection | `webex cc activities get-input-choices` | Resolve valid values for an activity input, such as queues, audio files, or agents; supports search, validation, and cascading parent inputs. | No — use the new command | ## cc agent-personal-greeting-files @@ -47,73 +47,73 @@ The refresh tables below contain **94 previous-to-current mappings**, followed b | Previous full command | Source | Current full command | What it does | Previous spelling still works? | | --- | --- | --- | --- | --- | -| `webex cc contact-service-queue list-skill-based-skill-profile-id` | PR #10 | `webex cc contact-service-queue list-by-skill-profile` | Retrieve a list of skill-based Contact Service Queues associated with a given skill profile ID, accessible to authorized clients in a given organization. | No — use the new command | +| `webex cc contact-service-queue list-skill-based-skill-profile-id` | Generated collection | `webex cc contact-service-queue list-by-skill-profile` | Retrieve a list of skill-based Contact Service Queues associated with a given skill profile ID, accessible to authorized clients in a given organization. | No — use the new command | | `webex cc contact-service-queue list-skill-csqs-skill-profile` | Before refresh | `webex cc contact-service-queue list-by-skill-profile` | Retrieve a list of skill-based Contact Service Queues associated with a given skill profile ID, accessible to authorized clients in a given organization. | Yes — alias | | `webex cc contact-service-queue delete-csq-references` | Before refresh | `webex cc contact-service-queue delete-references` | Removes the references to the specified entities (such as teams, sites, or agents) from Contact Service Queues for a given organization. | Yes — alias | | `webex cc contact-service-queue list-manually-assignable-csqs` | Before refresh | `webex cc contact-service-queue list-manually-assignable` | Retrieve a list of Contact Service Queues that are eligible for manual contact assignment based on the provided criteria in a given organization. | Yes — alias | | `webex cc contact-service-queue list-csq-references-id` | Before refresh | `webex cc contact-service-queue list-references` | Retrieve a list of all entities that have reference to an existing Contact Service Queue by ID in a given organization. | Yes — alias | -| `webex cc contact-service-queue list-agent-based-user-id` | PR #10 | `webex cc contact-service-queue list-agent-based` | Retrieve a list of agent-based Contact Service Queues by user ID in a given organization. | No — use the new command | -| `webex cc contact-service-queue list-skill-based-user-id` | PR #10 | `webex cc contact-service-queue list-skill-based` | Retrieve a list of skill-based Contact Service Queues by user ID in a given organization. | No — use the new command | -| `webex cc contact-service-queue list-team-based-user-id` | PR #10 | `webex cc contact-service-queue list-team-based` | Retrieve a list of team-based Contact Service Queues by user ID in a given organization. | No — use the new command | -| `webex cc contact-service-queue list-skill-based-dynamic-skills-skill-profile` | PR #10 | `webex cc contact-service-queue list-by-dynamic-skills` | Retrieve a list of skill-based Contact Service Queues that match the given dynamic skills and skill profile criteria in a given organization. | No — use the new command | +| `webex cc contact-service-queue list-agent-based-user-id` | Generated collection | `webex cc contact-service-queue list-agent-based` | Retrieve a list of agent-based Contact Service Queues by user ID in a given organization. | No — use the new command | +| `webex cc contact-service-queue list-skill-based-user-id` | Generated collection | `webex cc contact-service-queue list-skill-based` | Retrieve a list of skill-based Contact Service Queues by user ID in a given organization. | No — use the new command | +| `webex cc contact-service-queue list-team-based-user-id` | Generated collection | `webex cc contact-service-queue list-team-based` | Retrieve a list of team-based Contact Service Queues by user ID in a given organization. | No — use the new command | +| `webex cc contact-service-queue list-skill-based-dynamic-skills-skill-profile` | Generated collection | `webex cc contact-service-queue list-by-dynamic-skills` | Retrieve a list of skill-based Contact Service Queues that match the given dynamic skills and skill profile criteria in a given organization. | No — use the new command | | `webex cc contact-service-queue list-csqs-skills-profile` | Before refresh | `webex cc contact-service-queue list-by-dynamic-skills` | Retrieve a list of skill-based Contact Service Queues that match the given dynamic skills and skill profile criteria in a given organization. | Yes — alias | -| `webex cc contact-service-queue list-skill-based-skill-profile-id-user-id` | PR #10 | `webex cc contact-service-queue list-by-user-skill-profile` | Retrieve a list of skill-based Contact Service Queues associated with the given skill profile ID and user ID combination in a given organization. | No — use the new command | +| `webex cc contact-service-queue list-skill-based-skill-profile-id-user-id` | Generated collection | `webex cc contact-service-queue list-by-user-skill-profile` | Retrieve a list of skill-based Contact Service Queues associated with the given skill profile ID and user ID combination in a given organization. | No — use the new command | | `webex cc contact-service-queue list-csqs-user-profile` | Before refresh | `webex cc contact-service-queue list-by-user-skill-profile` | Retrieve a list of skill-based Contact Service Queues associated with the given skill profile ID and user ID combination in a given organization. | Yes — alias | ## cc events | Previous full command | Source | Current full command | What it does | Previous spelling still works? | | --- | --- | --- | --- | --- | -| `webex cc events list-specifications-2` | PR #10 | `webex cc events list-specifications` | List the event types available for use in `event_flows[]`. | No — use the new command | +| `webex cc events list-specifications-2` | Generated collection | `webex cc events list-specifications` | List the event types available for use in `event_flows[]`. | No — use the new command | ## cc flow | Previous full command | Source | Current full command | What it does | Previous spelling still works? | | --- | --- | --- | --- | --- | -| `webex cc flow export` | PR #10 | `webex cc flow export-legacy` | Export a flow or subflow in legacy raw FDL format. This API is deprecated; the existing command keeps its original route. | **No — now resolves to a different operation; use the new command.** | -| `webex cc flow import` | PR #10 | `webex cc flow import-legacy` | Import a flow or subflow in legacy raw FDL format. This API is deprecated; the existing command keeps its original route. | **No — now resolves to a different operation; use the new command.** | -| `webex cc flows list` | PR #10 | `webex cc flow list` | List flows or subflows, with name, ID, channel, and pagination filters. | Yes — alias | -| `webex cc flows publish` | PR #10 | `webex cc flow publish` | Publish a flow or subflow. | Yes — alias | -| `webex cc flows lock` | PR #10 | `webex cc flow lock` | Lock a flow or subflow against concurrent edits. Locks expire after 15 minutes of inactivity. | Yes — alias | -| `webex cc flows unlock` | PR #10 | `webex cc flow unlock` | Release a flow or subflow edit lock. | Yes — alias | -| `webex cc flows validate` | PR #10 | `webex cc flow validate` | Validate a supplied flow definition without saving it. Passing validation does not guarantee import will succeed. | Yes — alias | -| `webex cc flows import` | PR #10 | `webex cc flow import` | Import a v2 flow definition as a new draft and return the assigned flow metadata. | Yes — alias | -| `webex cc flows get` | PR #10 | `webex cc flow get` | Retrieve the current flow draft. Use export to retrieve a published version. | Yes — alias | -| `webex cc flows save-draft` | PR #10 | `webex cc flow save-draft` | Replace the complete flow draft. Optional expectedVersion prevents overwriting a concurrently changed draft. | Yes — alias | -| `webex cc flows patch-draft` | PR #10 | `webex cc flow patch-draft` | Apply a partial update to a flow draft; validate the merged result before saving it. | Yes — alias | -| `webex cc flows validate-draft` | PR #10 | `webex cc flow validate-draft` | Validate the stored flow draft without changing it. | Yes — alias | -| `webex cc flows export` | PR #10 | `webex cc flow export` | Export a v2 flow document for backup, migration, or version control. | Yes — alias | -| `webex cc flows list-2` | PR #10 | `webex cc flow list` | List flows or subflows, with name, ID, channel, and pagination filters. | No — use the new command | -| `webex cc flows publish-2` | PR #10 | `webex cc flow publish` | Publish a flow or subflow. | No — use the new command | -| `webex cc flows lock-2` | PR #10 | `webex cc flow lock` | Lock a flow or subflow against concurrent edits. Locks expire after 15 minutes of inactivity. | No — use the new command | -| `webex cc flows unlock-2` | PR #10 | `webex cc flow unlock` | Release a flow or subflow edit lock. | No — use the new command | -| `webex cc flows validate-2` | PR #10 | `webex cc flow validate` | Validate a supplied flow definition without saving it. Passing validation does not guarantee import will succeed. | No — use the new command | -| `webex cc flows import-2` | PR #10 | `webex cc flow import` | Import a v2 flow definition as a new draft and return the assigned flow metadata. | No — use the new command | -| `webex cc flows get-2` | PR #10 | `webex cc flow get` | Retrieve the current flow draft. Use export to retrieve a published version. | No — use the new command | -| `webex cc flows save-draft-2` | PR #10 | `webex cc flow save-draft` | Replace the complete flow draft. Optional expectedVersion prevents overwriting a concurrently changed draft. | No — use the new command | -| `webex cc flows patch-draft-2` | PR #10 | `webex cc flow patch-draft` | Apply a partial update to a flow draft; validate the merged result before saving it. | No — use the new command | -| `webex cc flows validate-draft-2` | PR #10 | `webex cc flow validate-draft` | Validate the stored flow draft without changing it. | No — use the new command | -| `webex cc flows export-2` | PR #10 | `webex cc flow export` | Export a v2 flow document for backup, migration, or version control. | No — use the new command | -| `webex cc flows search` | PR #10 | `webex cc flow search` | Search flows or subflows using a case-sensitive query. | No — use the new command | -| `webex cc flows delete` | PR #10 | `webex cc flow delete` | Permanently delete a flow or subflow; deletion cannot be undone. | No — use the new command | -| `webex cc legacy-flows export` | PR #10 | `webex cc flow export-legacy` | Export a flow or subflow in legacy raw FDL format. This API is deprecated; the existing command keeps its original route. | No — use the new command | -| `webex cc legacy-flows import` | PR #10 | `webex cc flow import-legacy` | Import a flow or subflow in legacy raw FDL format. This API is deprecated; the existing command keeps its original route. | No — use the new command | +| `webex cc flow export` | Generated collection | `webex cc flow export-legacy` | Export a flow or subflow in legacy raw FDL format. This API is deprecated; the existing command keeps its original route. | **No — now resolves to a different operation; use the new command.** | +| `webex cc flow import` | Generated collection | `webex cc flow import-legacy` | Import a flow or subflow in legacy raw FDL format. This API is deprecated; the existing command keeps its original route. | **No — now resolves to a different operation; use the new command.** | +| `webex cc flows list` | Generated collection | `webex cc flow list` | List flows or subflows, with name, ID, channel, and pagination filters. | Yes — alias | +| `webex cc flows publish` | Generated collection | `webex cc flow publish` | Publish a flow or subflow. | Yes — alias | +| `webex cc flows lock` | Generated collection | `webex cc flow lock` | Lock a flow or subflow against concurrent edits. Locks expire after 15 minutes of inactivity. | Yes — alias | +| `webex cc flows unlock` | Generated collection | `webex cc flow unlock` | Release a flow or subflow edit lock. | Yes — alias | +| `webex cc flows validate` | Generated collection | `webex cc flow validate` | Validate a supplied flow definition without saving it. Passing validation does not guarantee import will succeed. | Yes — alias | +| `webex cc flows import` | Generated collection | `webex cc flow import` | Import a v2 flow definition as a new draft and return the assigned flow metadata. | Yes — alias | +| `webex cc flows get` | Generated collection | `webex cc flow get` | Retrieve the current flow draft. Use export to retrieve a published version. | Yes — alias | +| `webex cc flows save-draft` | Generated collection | `webex cc flow save-draft` | Replace the complete flow draft. Optional expectedVersion prevents overwriting a concurrently changed draft. | Yes — alias | +| `webex cc flows patch-draft` | Generated collection | `webex cc flow patch-draft` | Apply a partial update to a flow draft; validate the merged result before saving it. | Yes — alias | +| `webex cc flows validate-draft` | Generated collection | `webex cc flow validate-draft` | Validate the stored flow draft without changing it. | Yes — alias | +| `webex cc flows export` | Generated collection | `webex cc flow export` | Export a v2 flow document for backup, migration, or version control. | Yes — alias | +| `webex cc flows list-2` | Generated collection | `webex cc flow list` | List flows or subflows, with name, ID, channel, and pagination filters. | No — use the new command | +| `webex cc flows publish-2` | Generated collection | `webex cc flow publish` | Publish a flow or subflow. | No — use the new command | +| `webex cc flows lock-2` | Generated collection | `webex cc flow lock` | Lock a flow or subflow against concurrent edits. Locks expire after 15 minutes of inactivity. | No — use the new command | +| `webex cc flows unlock-2` | Generated collection | `webex cc flow unlock` | Release a flow or subflow edit lock. | No — use the new command | +| `webex cc flows validate-2` | Generated collection | `webex cc flow validate` | Validate a supplied flow definition without saving it. Passing validation does not guarantee import will succeed. | No — use the new command | +| `webex cc flows import-2` | Generated collection | `webex cc flow import` | Import a v2 flow definition as a new draft and return the assigned flow metadata. | No — use the new command | +| `webex cc flows get-2` | Generated collection | `webex cc flow get` | Retrieve the current flow draft. Use export to retrieve a published version. | No — use the new command | +| `webex cc flows save-draft-2` | Generated collection | `webex cc flow save-draft` | Replace the complete flow draft. Optional expectedVersion prevents overwriting a concurrently changed draft. | No — use the new command | +| `webex cc flows patch-draft-2` | Generated collection | `webex cc flow patch-draft` | Apply a partial update to a flow draft; validate the merged result before saving it. | No — use the new command | +| `webex cc flows validate-draft-2` | Generated collection | `webex cc flow validate-draft` | Validate the stored flow draft without changing it. | No — use the new command | +| `webex cc flows export-2` | Generated collection | `webex cc flow export` | Export a v2 flow document for backup, migration, or version control. | No — use the new command | +| `webex cc flows search` | Generated collection | `webex cc flow search` | Search flows or subflows using a case-sensitive query. | No — use the new command | +| `webex cc flows delete` | Generated collection | `webex cc flow delete` | Permanently delete a flow or subflow; deletion cannot be undone. | No — use the new command | +| `webex cc legacy-flows export` | Generated collection | `webex cc flow export-legacy` | Export a flow or subflow in legacy raw FDL format. This API is deprecated; the existing command keeps its original route. | No — use the new command | +| `webex cc legacy-flows import` | Generated collection | `webex cc flow import-legacy` | Import a flow or subflow in legacy raw FDL format. This API is deprecated; the existing command keeps its original route. | No — use the new command | ## cc functions | Previous full command | Source | Current full command | What it does | Previous spelling still works? | | --- | --- | --- | --- | --- | -| `webex cc functions list-custom` | PR #10 | `webex cc functions list` | List or search custom functions in the organization. | No — use the new command | -| `webex cc functions create-custom` | PR #10 | `webex cc functions create` | Create a new custom function. | No — use the new command | -| `webex cc functions get-custom` | PR #10 | `webex cc functions get` | Retrieve a function draft, or a specific published version/tag. | No — use the new command | -| `webex cc functions update-custom` | PR #10 | `webex cc functions update` | Update an existing custom function by ID. | No — use the new command | -| `webex cc functions delete-custom` | PR #10 | `webex cc functions delete` | Delete a custom function by ID. | No — use the new command | -| `webex cc functions import-custom` | PR #10 | `webex cc functions import` | Import a function-definition JSON file as a multipart upload. The current generated CLI command still lacks file-upload handling; naming it does not fix that limitation. | No — use the new command | -| `webex cc functions unlock-custom` | PR #10 | `webex cc functions unlock` | Release the edit lock on a custom function so that other users can edit it. | No — use the new command | -| `webex cc functions lock-custom` | PR #10 | `webex cc functions lock` | Acquire an edit lock on a custom function to prevent concurrent writes by other users. | No — use the new command | -| `webex cc functions test-custom` | PR #10 | `webex cc functions test` | Execute a function with a test payload. The API implicitly publishes the latest draft before running it. | No — use the new command | -| `webex cc functions publish-custom` | PR #10 | `webex cc functions publish` | Publish the latest function draft under one or more tags: Dev, Test, Latest, or Live. | No — use the new command | -| `webex cc functions export-custom` | PR #10 | `webex cc functions export` | Export a selected function version or publish tag as function-definition JSON, including source code, inputs, and outputs. | No — use the new command | +| `webex cc functions list-custom` | Generated collection | `webex cc functions list` | List or search custom functions in the organization. | No — use the new command | +| `webex cc functions create-custom` | Generated collection | `webex cc functions create` | Create a new custom function. | No — use the new command | +| `webex cc functions get-custom` | Generated collection | `webex cc functions get` | Retrieve a function draft, or a specific published version/tag. | No — use the new command | +| `webex cc functions update-custom` | Generated collection | `webex cc functions update` | Update an existing custom function by ID. | No — use the new command | +| `webex cc functions delete-custom` | Generated collection | `webex cc functions delete` | Delete a custom function by ID. | No — use the new command | +| `webex cc functions import-custom` | Generated collection | `webex cc functions import` | Import a function-definition JSON file as a multipart upload. The current generated CLI command still lacks file-upload handling; naming it does not fix that limitation. | No — use the new command | +| `webex cc functions unlock-custom` | Generated collection | `webex cc functions unlock` | Release the edit lock on a custom function so that other users can edit it. | No — use the new command | +| `webex cc functions lock-custom` | Generated collection | `webex cc functions lock` | Acquire an edit lock on a custom function to prevent concurrent writes by other users. | No — use the new command | +| `webex cc functions test-custom` | Generated collection | `webex cc functions test` | Execute a function with a test payload. The API implicitly publishes the latest draft before running it. | No — use the new command | +| `webex cc functions publish-custom` | Generated collection | `webex cc functions publish` | Publish the latest function draft under one or more tags: Dev, Test, Latest, or Live. | No — use the new command | +| `webex cc functions export-custom` | Generated collection | `webex cc functions export` | Export a selected function version or publish tag as function-definition JSON, including source code, inputs, and outputs. | No — use the new command | ## cc outdial-ani @@ -121,7 +121,7 @@ The refresh tables below contain **94 previous-to-current mappings**, followed b | --- | --- | --- | --- | --- | | `webex cc outdial-ani list-entry` | Before refresh | `webex cc outdial-ani list-entries` | Retrieve a list of Outdial ANI Entries in a given organization. | Yes — alias | | `webex cc outdial-ani bulk-save-entry` | Before refresh | `webex cc outdial-ani bulk-save-entries` | Create, Update or delete Outdial ANI Entries in bulk for an Address Book in a given organization. | Yes — alias | -| `webex cc outdial-ani list-entries-2` | PR #10 | `webex cc outdial-ani list-entries-for-ani` | List outbound caller-ID (ANI) entries belonging to a specified outdial ANI ID. | No — use the new command | +| `webex cc outdial-ani list-entries-2` | Generated collection | `webex cc outdial-ani list-entries-for-ani` | List outbound caller-ID (ANI) entries belonging to a specified outdial ANI ID. | No — use the new command | | `webex cc outdial-ani list-entry-2` | Before refresh | `webex cc outdial-ani list-entries-for-ani` | List outbound caller-ID (ANI) entries belonging to a specified outdial ANI ID. | Yes — alias | ## cc tasks @@ -130,27 +130,27 @@ The refresh tables below contain **94 previous-to-current mappings**, followed b | --- | --- | --- | --- | --- | | `webex cc tasks resume` | Before refresh | `webex cc tasks unhold` | Resume a voice call that is on hold. This preserves the released meaning of `tasks resume`. | Yes — alias | | `webex cc tasks update-2` | Before refresh | `webex cc tasks append-message` | Append a message to an existing task using the v2 messages endpoint (beta). | Yes — alias | -| `webex cc tasks pause` | PR #10 | `webex cc tasks pause-digital` | Pause a non-real-time digital task that cannot be handled immediately. | No — use the new command | -| `webex cc tasks resume` | PR #10 | `webex cc tasks resume-digital` | Resume a paused non-real-time digital task, such as email or social messaging. | **No — now resolves to a different operation; use the new command.** | +| `webex cc tasks pause` | Generated collection | `webex cc tasks pause-digital` | Pause a non-real-time digital task that cannot be handled immediately. | No — use the new command | +| `webex cc tasks resume` | Generated collection | `webex cc tasks resume-digital` | Resume a paused non-real-time digital task, such as email or social messaging. | **No — now resolves to a different operation; use the new command.** | ## cc templates | Previous full command | Source | Current full command | What it does | Previous spelling still works? | | --- | --- | --- | --- | --- | -| `webex cc templates list-flow-2` | PR #10 | `webex cc templates list-flow` | List available flow templates that can be used to create new flows. | No — use the new command | -| `webex cc templates get-flow-2` | PR #10 | `webex cc templates get-flow` | Retrieve a specific flow template by its ID. | No — use the new command | +| `webex cc templates list-flow-2` | Generated collection | `webex cc templates list-flow` | List available flow templates that can be used to create new flows. | No — use the new command | +| `webex cc templates get-flow-2` | Generated collection | `webex cc templates get-flow` | Retrieve a specific flow template by its ID. | No — use the new command | ## cc usage-reports | Previous full command | Source | Current full command | What it does | Previous spelling still works? | | --- | --- | --- | --- | --- | -| `webex cc usage-reports get-available-types` | PR #10 | `webex cc usage-reports list-resource-types` | Returns the list of available resource types that can be used for report generation, along with available data dates. | No — use the new command | +| `webex cc usage-reports get-available-types` | Generated collection | `webex cc usage-reports list-resource-types` | Returns the list of available resource types that can be used for report generation, along with available data dates. | No — use the new command | ## cc users | Previous full command | Source | Current full command | What it does | Previous spelling still works? | | --- | --- | --- | --- | --- | -| `webex cc users list-2` | PR #10 | `webex cc users list-by-ids` | Retrieve an existing User's first name, last name and email by list of IDs in a given organization. | No — use the new command | +| `webex cc users list-2` | Generated collection | `webex cc users list-by-ids` | Retrieve an existing User's first name, last name and email by list of IDs in a given organization. | No — use the new command | | `webex cc users get-ids` | Before refresh | `webex cc users list-by-ids` | Retrieve an existing User's first name, last name and email by list of IDs in a given organization. | Yes — alias | | `webex cc users bulk-update-dynamic-skills` | Before refresh | `webex cc users bulk-partial-update-dynamic-skills` | Assign or unassign a dynamic skill to/from multiple users in bulk for a given organization. | Yes — alias | @@ -158,55 +158,19 @@ The refresh tables below contain **94 previous-to-current mappings**, followed b | Previous full command | Source | Current full command | What it does | Previous spelling still works? | | --- | --- | --- | --- | --- | -| `webex messaging hds get-database-org-2` | PR #10 | `webex messaging hds get-database-config-org` | Retrieve details of database information for an HDS organization, such as database type and version used. | Yes — alias | -| `webex messaging hds get-multi-tenant-org-2` | PR #10 | `webex messaging hds list-tenants-org` | Retrieve tenant organization names/IDs, tenant states, and customer-managed-key state for a multi-tenant HDS organization. | Yes — alias | -| `webex messaging hybrid-data-security get-org` | PR #10 | `webex messaging hds get-org` | Retrieve details for an Hybrid Data Security organization, such as the organization name, type of organization. | Yes — alias | -| `webex messaging hybrid-data-security list-clusters-org` | PR #10 | `webex messaging hds list-clusters-org` | Retrieve a list of all clusters for a specific Hybrid Data Security organization, including cluster status, release channel, and upgrade schedule details. | Yes — alias | -| `webex messaging hybrid-data-security get-cluster` | PR #10 | `webex messaging hds get-cluster` | Retrieve details for a specific Hybrid Data Security cluster, such as the cluster name, cluster status, upgrade schedule, and Hybrid Data Security nodes in the cluster. | Yes — alias | -| `webex messaging hybrid-data-security list-nodes-cluster` | PR #10 | `webex messaging hds list-nodes-cluster` | Retrieve a list of all nodes for a specific Hybrid Data Security cluster, including availability, proxy details, deployment type, and release version. | Yes — alias | -| `webex messaging hybrid-data-security get-node` | PR #10 | `webex messaging hds get-node` | Retrieve details for a specific Hybrid Data Security node, such as host name, release version, proxy details, deployment and build type, availability details, etc. | Yes — alias | -| `webex messaging hybrid-data-security get-database-org` | PR #10 | `webex messaging hds get-database-config-org` | Retrieve details of database information for an Hybrid Data Security organization, such as database type and version used. | **No — now resolves to a different operation; use the new command.** | -| `webex messaging hybrid-data-security get-multi-tenant-org` | PR #10 | `webex messaging hds list-tenants-org` | Retrieve tenant organization names/IDs, tenant states, and customer-managed-key state for a multi-tenant HDS organization. | **No — now resolves to a different operation; use the new command.** | -| `webex messaging hybrid-data-security get-alarms-node` | PR #10 | `webex messaging hds get-alarms-node` | Returns the alarm details for a single Hybrid Data Security node for the provided time range (last 24 hours). | Yes — alias | -| `webex messaging hybrid-data-security get-test-results-node` | PR #10 | `webex messaging hds get-test-results-node` | Retrieve the latest node network-test results, including bandwidth, DNS resolution, and HTTPS connectivity. | Yes — alias | -| `webex messaging hybrid-data-security get-usage-node` | PR #10 | `webex messaging hds get-usage-node` | Retrieve CPU, memory, and disk resource usage details for a specific Hybrid Data Security node over the requested time range. | Yes — alias | -| `webex messaging hybrid-data-security get-availability-cluster` | PR #10 | `webex messaging hds get-availability-cluster` | Get the availability details for an Hybrid Data Security cluster, where each segment specifies the start and end times, as well as the number of online, offline, and total nodes within that segment. | Yes — alias | - -## Cloverhound read-only route checks — 2026-09-29 - -Tested with the Cloverhound organization on `https://api.wxcc-us1.cisco.com` using authenticated GET requests only. No import, publish, lock, save, patch, or delete requests were executed. - -| Operation | With `/flow-store/` | Without `/flow-store/` | Comparison | -| --- | --- | --- | --- | -| List flows | 200 | 200 | Identical parsed JSON | -| Get one flow draft | 200 | 200 | Identical parsed JSON | -| Export that flow using the current format | 200 | 200 | Identical parsed JSON | -| List activity definitions | 200 | 200 | Identical parsed JSON | -| List event specifications | 200 | 200 | Identical parsed JSON | -| List templates | 404 at the org/project-scoped v2 template route | 200 at `/templates` | Different routing behavior | - -Legacy flow export also returned 200 and an FDL document. For this organization and the tested reads, both flow URL forms work on the same production host. This does not establish equivalence for all operations or tenants. The subsequent draft write checks below support consolidating current operations onto unprefixed routes. `webex cc templates list-flow` now uses `/templates`. Activity input choices retain the unprefixed request’s search/validate/parent-input parameters. - -## Cloverhound disposable-flow write checks — 2026-09-29 (Denver) - -Created draft `CLI_Route_Test_ce61ca68ca8b` (ID `6abc548b79b443250d35110c`) using the unprefixed import URL with `overwrite=false`. The flow contained only a start activity and a disconnect activity. It was never published or assigned to an entry point/routing strategy. - -| Check | Result | -| --- | --- | -| Validate through unprefixed route | Valid; only a recommendation to add activity descriptions | -| Import through unprefixed route | 201; new unassigned draft | -| Read new draft through `/flow-store/` route | 200; correct new flow | -| Lock prefixed, unlock unprefixed | Both 200 | -| Lock unprefixed, unlock prefixed | Both 200 | -| Patch description prefixed, read unprefixed | Both 200; updated description verified | -| Patch description unprefixed, read prefixed | Both 200; updated description verified | -| Save complete draft prefixed, read unprefixed | Both 200; saved description verified | -| Save complete draft unprefixed, read prefixed | Both 200; saved description verified | -| Export draft through both routes | Both 200; correct test flow | -| Delete through unprefixed route, without force or skipped reference checks | 200 | -| Read deleted flow through both routes | Both 404; cleanup confirmed | - -These checks establish that both URL forms act on the same flow and support the tested draft lifecycle in Cloverhound. The unprefixed URLs are sufficient for those current-format operations; separate prefixed command variants provide no demonstrated additional capability. Publish and legacy import/export were not exercised in this write test. Keep legacy-format commands distinct from current-format commands regardless of URL-prefix consolidation. +| `webex messaging hds get-database-org-2` | Generated collection | `webex messaging hds get-database-config-org` | Retrieve details of database information for an HDS organization, such as database type and version used. | Yes — alias | +| `webex messaging hds get-multi-tenant-org-2` | Generated collection | `webex messaging hds list-tenants-org` | Retrieve tenant organization names/IDs, tenant states, and customer-managed-key state for a multi-tenant HDS organization. | Yes — alias | +| `webex messaging hybrid-data-security get-org` | Generated collection | `webex messaging hds get-org` | Retrieve details for an Hybrid Data Security organization, such as the organization name, type of organization. | Yes — alias | +| `webex messaging hybrid-data-security list-clusters-org` | Generated collection | `webex messaging hds list-clusters-org` | Retrieve a list of all clusters for a specific Hybrid Data Security organization, including cluster status, release channel, and upgrade schedule details. | Yes — alias | +| `webex messaging hybrid-data-security get-cluster` | Generated collection | `webex messaging hds get-cluster` | Retrieve details for a specific Hybrid Data Security cluster, such as the cluster name, cluster status, upgrade schedule, and Hybrid Data Security nodes in the cluster. | Yes — alias | +| `webex messaging hybrid-data-security list-nodes-cluster` | Generated collection | `webex messaging hds list-nodes-cluster` | Retrieve a list of all nodes for a specific Hybrid Data Security cluster, including availability, proxy details, deployment type, and release version. | Yes — alias | +| `webex messaging hybrid-data-security get-node` | Generated collection | `webex messaging hds get-node` | Retrieve details for a specific Hybrid Data Security node, such as host name, release version, proxy details, deployment and build type, availability details, etc. | Yes — alias | +| `webex messaging hybrid-data-security get-database-org` | Generated collection | `webex messaging hds get-database-config-org` | Retrieve details of database information for an Hybrid Data Security organization, such as database type and version used. | **No — now resolves to a different operation; use the new command.** | +| `webex messaging hybrid-data-security get-multi-tenant-org` | Generated collection | `webex messaging hds list-tenants-org` | Retrieve tenant organization names/IDs, tenant states, and customer-managed-key state for a multi-tenant HDS organization. | **No — now resolves to a different operation; use the new command.** | +| `webex messaging hybrid-data-security get-alarms-node` | Generated collection | `webex messaging hds get-alarms-node` | Returns the alarm details for a single Hybrid Data Security node for the provided time range (last 24 hours). | Yes — alias | +| `webex messaging hybrid-data-security get-test-results-node` | Generated collection | `webex messaging hds get-test-results-node` | Retrieve the latest node network-test results, including bandwidth, DNS resolution, and HTTPS connectivity. | Yes — alias | +| `webex messaging hybrid-data-security get-usage-node` | Generated collection | `webex messaging hds get-usage-node` | Retrieve CPU, memory, and disk resource usage details for a specific Hybrid Data Security node over the requested time range. | Yes — alias | +| `webex messaging hybrid-data-security get-availability-cluster` | Generated collection | `webex messaging hds get-availability-cluster` | Get the availability details for an Hybrid Data Security cluster, where each segment specifies the start and end times, as well as the number of online, offline, and total nodes within that segment. | Yes — alias | ## Redundant ID suffixes @@ -305,6 +269,6 @@ The ID remains a parameter: `get --id`, `delete --id`, `patch --id`, and `update ## Maintaining this reference -Duplicate prefixed entries are excluded through `SUPERSEDED_ROUTES` in `codegen/naming_overrides.py`. Each exclusion identifies a required replacement request; extraction fails if it disappears. The generator keeps the replacement’s complete request contract. Legacy import/export retain their prefixed routes. Publish uses the unprefixed route but was not live-tested. +Duplicate prefixed entries are excluded through `SUPERSEDED_ROUTES` in `codegen/naming_overrides.py`. Each exclusion identifies a required replacement request; extraction fails if it disappears. The generator keeps the replacement’s complete request contract. Legacy import/export retain their prefixed routes. Publish uses the unprefixed route. Exact `get-id`, `delete-id`, `patch-id`, and `update-id` names are shortened centrally by `apply_naming_overrides` in `codegen/extract_api_spec.py`, with collision checks and old-name aliases. Route-specific names and compatibility aliases are defined in `codegen/naming_overrides.py` and applied to the enriched spec before generating Go commands and skill references. Update the override table, run `make codegen`, and update this reference when changing a mapping. Handwritten request implementations continue to use `custom_*.go` and the generator skip lists. diff --git a/site/README.md b/site/README.md index 3f00773..58d3ed4 100644 --- a/site/README.md +++ b/site/README.md @@ -8,4 +8,4 @@ npm run dev npm run build ``` -Build output is `dist/`. The repository Pages workflow publishes the site. The Postman refresh inventory and command migration map are maintained in `../codegen/INVENTORY.md` and `../codegen/NAMING.md`. +Build output is `dist/`. The repository Pages workflow publishes the site. The Postman refresh inventory and command migration map are maintained in `../docs/command-inventory.md` and `../docs/command-migration.md`. diff --git a/site/src/content/docs/agent-skill.mdx b/site/src/content/docs/agent-skill.mdx index cc23f23..0b71d7a 100644 --- a/site/src/content/docs/agent-skill.mdx +++ b/site/src/content/docs/agent-skill.mdx @@ -91,4 +91,4 @@ The skill can be customized — just ask your coding agent to modify it. For exa `make codegen` refreshes the generated command tables for all six repository sub-skills. Handwritten guidance documents flow format migration, compatibility aliases, new command groups, and known upload limitations. Install the skills from the same CLI revision you use; older installed copies may show names removed by the refresh. -For the reviewed refresh inventory and old-to-new command map, see [INVENTORY.md](https://github.com/Cloverhound/webex-cli/blob/main/codegen/INVENTORY.md) and [NAMING.md](https://github.com/Cloverhound/webex-cli/blob/main/codegen/NAMING.md) in the repository. +For the reviewed refresh inventory and old-to-new command map, see [command inventory](https://github.com/Cloverhound/webex-cli/blob/main/docs/command-inventory.md) and [command migration map](https://github.com/Cloverhound/webex-cli/blob/main/docs/command-migration.md) in the repository. diff --git a/site/src/content/docs/cc.mdx b/site/src/content/docs/cc.mdx index f53ef5b..b0556d4 100644 --- a/site/src/content/docs/cc.mdx +++ b/site/src/content/docs/cc.mdx @@ -174,9 +174,9 @@ webex cc templates list-flow Bodies must be supplied with `--body` or `--body-file`; these generated commands do not read stdin. The CLI uses the fixed project ID internally. `--organization` overrides the login organization. -Cloverhound checks verified reads and an unpublished disposable draft's import, lock/unlock, patch, save, export, and deletion across both URL forms. The draft was deleted and both routes returned 404 afterward. Publish was not live-tested. Templates use `/templates`; the scoped prefixed template list returned 404. +Current flow, activity, and event commands use unprefixed routes. Template discovery uses `/templates`. Legacy flow import/export retain their separate FDL contract. -**Import limitations:** `flow import-legacy` and `functions import` are exposed but their generated commands do not implement the required upload body. Do not use them for migration until upload handling is implemented. Current `flow import --body-file` was live-tested successfully. +**Import limitations:** `flow import-legacy` and `functions import` are exposed but their generated commands do not implement the required upload body. Do not use them for migration until upload handling is implemented. ## Other refreshed Contact Center APIs @@ -198,8 +198,6 @@ webex cc usage-reports download-file --file-id --output raw > report.b webex cc external-data-updates update-task-global-variables --body-file task-update.json ``` -Discover report types before creating a report; the collection does not enumerate the types or CSV columns. Download with `fileId`, not `reportId`. Reports can span available data up to 36 months, may split into monthly files, and expire seven days after completion. Only one report processes per organization at a time. - -Cloverhound live tests returned `AgentActivityRecord`, `AgentSessionRecord`, `ContactActivityRecord`, `ContactSessionRecord`, and `ContactLegRecord`. A single-day Contact Session Record report completed and downloaded as gzip-compressed CSV; check the downloaded format before parsing it. Use `--output raw` to preserve file bytes. Report deletion and cleanup were verified. Completed-task variable updates have only been dry-run checked. +Discover report types before creating a report; the collection does not enumerate the types or CSV columns. Download with `fileId`, not `reportId`. Reports can span available data up to 36 months, may split into monthly files, and expire seven days after completion. Only one report processes per organization at a time. Downloads may be gzip-compressed CSV; check the format before parsing and use `--output raw` to preserve file bytes. For task controls, `unhold` (alias `resume`) resumes a held voice call; `pause-digital` and `resume-digital` handle paused non-real-time digital tasks. `append-message` retains `update-2` as an alias. Queue lookups use `list-agent-based`, `list-skill-based`, `list-team-based`, `list-by-skill-profile`, `list-by-dynamic-skills`, and `list-by-user-skill-profile`; pass IDs as flags. Whisper coaching is beta. The refresh also adds conference-participant removal, campaign-time lookup, and contact closure across a campaign chain. diff --git a/skill/SKILL.md b/skill/SKILL.md index d12c477..b1aa0a4 100644 --- a/skill/SKILL.md +++ b/skill/SKILL.md @@ -246,9 +246,9 @@ webex cc templates list-flow Bodies must be supplied with `--body` or `--body-file`; these generated commands do not read stdin. The CLI uses the fixed project ID internally. `--organization` overrides the login organization. -Cloverhound checks verified reads and an unpublished disposable draft's import, lock/unlock, patch, save, export, and deletion across both URL forms. The draft was deleted and both routes returned 404 afterward. Publish was not live-tested. Templates use `/templates`; the scoped prefixed template list returned 404. +Current flow, activity, and event commands use unprefixed routes. Template discovery uses `/templates`. Legacy flow import/export retain their separate FDL contract. -**Import limitations:** `flow import-legacy` and `functions import` are exposed but their generated commands do not implement the required upload body. Do not use them for migration until upload handling is implemented. Current `flow import --body-file` was live-tested successfully. +**Import limitations:** `flow import-legacy` and `functions import` are exposed but their generated commands do not implement the required upload body. Do not use them for migration until upload handling is implemented. ## Filtering and Pagination diff --git a/skill/cc/SKILL.md b/skill/cc/SKILL.md index 142b79a..4628191 100644 --- a/skill/cc/SKILL.md +++ b/skill/cc/SKILL.md @@ -157,9 +157,9 @@ webex cc templates list-flow Bodies must be supplied with `--body` or `--body-file`; these generated commands do not read stdin. The CLI uses the fixed project ID internally. `--organization` overrides the login organization. -Cloverhound checks verified reads and an unpublished disposable draft's import, lock/unlock, patch, save, export, and deletion across both URL forms. The draft was deleted and both routes returned 404 afterward. Publish was not live-tested. Templates use `/templates`; the scoped prefixed template list returned 404. +Current flow, activity, and event commands use unprefixed routes. Template discovery uses `/templates`. Legacy flow import/export retain their separate FDL contract. -**Import limitations:** `flow import-legacy` and `functions import` are exposed but their generated commands do not implement the required upload body. Do not use them for migration until upload handling is implemented. Current `flow import --body-file` was live-tested successfully. +**Import limitations:** `flow import-legacy` and `functions import` are exposed but their generated commands do not implement the required upload body. Do not use them for migration until upload handling is implemented. ## Other refreshed Contact Center APIs @@ -181,9 +181,7 @@ webex cc usage-reports download-file --file-id --output raw > report.b webex cc external-data-updates update-task-global-variables --body-file task-update.json ``` -Discover report types before creating a report; the collection does not enumerate the types or CSV columns. Download with `fileId`, not `reportId`. Reports can span available data up to 36 months, may split into monthly files, and expire seven days after completion. Only one report processes per organization at a time. - -Cloverhound live tests returned `AgentActivityRecord`, `AgentSessionRecord`, `ContactActivityRecord`, `ContactSessionRecord`, and `ContactLegRecord`. A single-day Contact Session Record report completed and downloaded as gzip-compressed CSV; check the downloaded format before parsing it. Use `--output raw` to preserve file bytes. Report deletion accepts the service's non-JSON acknowledgement; cleanup returned 204 and subsequent retrieval returned 404. Completed-task variable updates have only been dry-run checked. +Discover report types before creating a report; the collection does not enumerate the types or CSV columns. Download with `fileId`, not `reportId`. Reports can span available data up to 36 months, may split into monthly files, and expire seven days after completion. Only one report processes per organization at a time. Downloads may be gzip-compressed CSV; check the format before parsing and use `--output raw` to preserve file bytes. For task controls, `unhold` (alias `resume`) resumes a held voice call; `pause-digital` and `resume-digital` handle paused non-real-time digital tasks. `append-message` retains `update-2` as an alias. Queue lookups use `list-agent-based`, `list-skill-based`, `list-team-based`, `list-by-skill-profile`, `list-by-dynamic-skills`, and `list-by-user-skill-profile`; pass IDs as flags. Whisper coaching is beta. The refresh also adds conference-participant removal, campaign-time lookup, and contact closure across a campaign chain.